Skip to content

README.md

Latest commit

 

History

History
89 lines (54 loc) · 3.4 KB

README.md

File metadata and controls

89 lines (54 loc) · 3.4 KB

numjuggler

Tool to rename cells, surfaces, materials and universes in MCNP input files. See https://numjuggler.readthedocs.io

Current status

Build Status -- shows status of the tests defined in travis_tests folder.

PyPI version -- available from PyPI.

Documentation Status -- documentation

Information in the help message, returned by numjuggler -h mode is outdated. Therefore, the best way to see all current modes is to search for args.mode == string in main.py, and read comments in the correspondent sections of code.

Documentation

https://numjuggler.readthedocs.io should be considered as the main source of information.

There is also a github repo numjuggler.docs containing presentations and reports related to numjuggler.

Install

The numjuggler package is available at PyPI: https://pypi.org/project/numjuggler/. The preffered way to install it using pip:

>pip install numjuggler

Alternatively, one can clone from github and install in so-called development mode:

>git clone git@github.com:travleev/numjuggler.git
>cd numjuggler
>pip install -e .

Support the project

  • Please report here any bugs or unclear behaviour,
  • do not hesitate to propose new features to implement,
  • Curerrent documentation is outdated and the code needs refactoring. Consider sponsoring the project to support this activity.
  • Travis CI is not more active for this repository. If you know alternatives or can help to organize CI for numjuggler -- let me know.