scale-olm 0.10.3

ORIGEN Library Manager: A tool for building and managing ORIGEN reactor data libraries

Developing OLM

OLM is the ORIGEN Library Manager, a command line utility that streamlines aspects of using the ORIGEN library to solve nuclide inventory generation problems.

If you would like to learn how to use OLM, see the user docs.

The script dev.sh is provided to initialize the development environment.

$ git clone https://code.ornl.gov/scale/code/olm
$ cd olm
$ source dev.sh

Developer details

This section contains additional details on developing OLM.

Enable virtual environment

$ virtualenv venv
$ . venv/bin/activate
$ which python

If you get an error about missing virtualenv, you may need to install it.

$ pip install virtualenv

Install requirements

After enabling the virtual environment, run this command to install dependencies.

$ pip install -r requirements.txt

NOTE: if you need to regenerate the requirements file after adding dependencies.

$ pip freeze | grep -v '^\-e'>requirements.txt

Enable a local install for testing

This command will enable any changes you make to instantly propagate to the executable you can run just with olm.

$ pip install --editable .
$ olm
$ which olm

Creating docs

With the development environment installed, the docs may be created within the docs directory. With the following commands.

$ cd docs
$ make html
$ open build/html/index.html

Alternatively the PDF docs may be generated using the make latexpdf command. Note that the HTML docs are intended as the main documentation.

The following greatly simplifies iterating on documentation. Run this command and open your browser to http://localhost:8000.

sphinx-autobuild docs/source/ docs/build/html/

Notebooks

There are notebooks contained in notebooks which may be helpful for debugging or understanding how something is working. You may need to install your virtual environment kernel for the notebooks to work. You should use the local venv kernel instead of your default Python kernel so you have all the local packages at the correct versions.

$ ipython kernel install --name "venv" --user

Now, you can select the created kernel "venv" when you start Jupyter notebook or lab.

Notes about development

Click for CLI

We use the Click python library for command line. Here's a nice video about click.

Commit messages

Follow these guidelines for commit messages.

Version updates

OLM uses semantic versioning. You should commit the relevant code with the usual description commit message. Then run bumpversion major, bumpversion minor, or bumpversion patch which will automatically create a new commit message and version tag. When you push you need to git push --tags or configure your repo to always push tags:

#.git/config
[remote "origin"]
    push = +refs/tags/*:refs/tags/*

Pytest for unit tests

Locally for unit tests we use the pytest framework under the testing directory. All tests can be run simply like this from the root directory. Not we are using the pytest-xdist extension which allows parallel testing.

$ pytest -n 6 .

Black for commit formatting

The first time you do work on a clone, do this.

$ pre-commit install

This will use the Black formatter.

Docstrings and Doctest

Our goal is to have each function, module, and class with standard docstrings and a few doctests. You can run verbose tests on a specific module as follows.

$ pytest -v scale/olm/core.py