Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme update for github release #3

Merged
merged 5 commits into from
Jan 12, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
# MontePy

<img src="https://raw.githubusercontent.com/idaholab/MontePy/develop/graphics/monty.svg" width="180" alt="MontePY: a cute snek on a red over white circle"/>

A python library to read, edit, and write MCNP input files.

## Installing

See the [Installing section in the user guide](https://experiment_analysis_all.pages.hpc.inl.gov/software/montepy/starting.html#installing).
See the [Installing section in the user guide](https://idaholab.github.io/MontePy/starting.html#installing).


## User Documentation

MontePy has a [sphinx website](https://experiment_analysis_all.pages.hpc.inl.gov/software/montepy/).
MontePy has a [sphinx website](https://idaholab.github.io/MontePy/index.html).
This has a getting started guide for users,
as well as API documentation.
There is also a developer's guide covering the design and approach of MontePy, and how to contribute.
Expand All @@ -19,9 +21,9 @@ There is also a developer's guide covering the design and approach of MontePy, a
* Handles almost all MCNP input syntax including: message blocks, & continue, comments, etc.
* Parses Cells, surfaces, materials, and transforms very well.
* Can parse the following surfaces exactly P(X|Y|Z), C(X|Y|Z), C/(X|Y|Z) (I mean it can do PX, and PY, etc.)
* Can read in all other cards but not understand them
* Can write out full MCNP problem even if it doesn't fully understand a card.
* Can write out the MCNP problem verbatim, if it has not been modified at all.
* Can read in all other inputs but not understand them
* Can write out full MCNP problem even if it doesn't fully understand an input.
* Can write out the MCNP problem verbatim, and try to match
* Can quickly access cells, surfaces, and materials by their numbers. For example: `cell = problem.cells[105]`.
* Can quickly update cell importances. For example `cell.importance.neutron = 2.0`.
* Has over 240 test cases right now
Expand Down Expand Up @@ -56,7 +58,7 @@ So MontePy doesn't do what you want? Right now development is done with a Just-
If there's a feature you want add an issue here with the feature request tag.
If you want to add a feature on your own talk to Micah Gale (but still add the issue).
The system is very modular and you should be able to develop it pretty quickly.
Also read the [developer's guide](https://experiment_analysis_all.pages.hpc.inl.gov/software/montepy/developing.html).
Also read the [developer's guide](https://idaholab.github.io/MontePy/developing.html).

# Version Numbering Scheme

Expand All @@ -70,4 +72,4 @@ Also read the [developer's guide](https://experiment_analysis_all.pages.hpc.inl.
Official shall not change. New merges to main shall have a version number incremented.


# Finally: make objects not regexs!
# Finally: make objects not regexes!
4 changes: 2 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
# -- Project information -----------------------------------------------------

project = "MontePy"
copyright = "2021 – 2023, Battelle Energy Alliance LLC."
author = "Micah D. Gale (@galemica), Travis J. Labossiere-Hickman (@tjlaboss)"
copyright = "2021 – 2024, Battelle Energy Alliance LLC."
author = "Micah D. Gale (@micahgale), Travis J. Labossiere-Hickman (@tjlaboss)"


release = importlib.metadata.version("montepy")
Expand Down
2 changes: 1 addition & 1 deletion montepy/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
from montepy.universe import Universe
import sys

__version__ = "0.2.5dev1"
__version__ = "0.2.5dev2"
# enable deprecated warnings for users
if not sys.warnoptions:
import os, warnings
Expand Down
8 changes: 5 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ authors = [
{name = "Travis Labossiere-Hickman", email = "Travis.LabossiereHickman@inl.gov"},
{name = "Brenna Carbno"}
]
keywords = ["MCNP", "neutronics", "imcnp", "input file", "monte carlo"]
keywords = ["MCNP", "neutronics", "imcnp", "input file", "monte carlo", "radiation transport"]
license = {file="LICENSE"}
classifiers = [
"Development Status :: 4 - Beta",
"Programming Language :: Python :: 3 :: Only",
"Intended Audience :: Science/Research",
"Intended Audience :: Developers",
# "License :: OSI Approved :: MIT License",
"License :: OSI Approved :: MIT License",
"Natural Language :: English",
"Operating System :: OS Independent",
"Topic :: Scientific/Engineering :: Physics",
Expand All @@ -39,8 +39,10 @@ test = ["coverage", "pytest"]
doc = ["sphinx", "sphinxcontrib-apidoc", "sphinx_rtd_theme"]

[project.urls]
Homepage = "https://github.com/idaholab/montepy"
Homepage = "https://idaholab.github.io/MontePy/index.html"
Repository = "https://github.com/idaholab/montepy.git"
Documentation = "https://idaholab.github.io/MontePy/index.html"
"Bug Tracker" = "https://github.com/idaholab/MontePy/issues"

[build-system]
requires = ["setuptools >= 61.0.0"]
Expand Down