| Name | scale-olm JSON |
| Version |
0.12.4
JSON |
| download |
| home_page | |
| Summary | ORIGEN Library Manager: A tool for building and managing ORIGEN reactor data libraries |
| upload_time | 2024-02-16 03:25:13 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | Copyright 2024 UT-Battelle, LLC Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
scale
origen
library
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## ORIGEN Library Manager (OLM)
[](https://scale-olm.readthedocs.io/en/v0.12.4)
This is version [v0.12.4](https://scale-olm.readthedocs.io/en/v0.12.4).
OLM is a command-line utility that streamlines aspects of using the
[SCALE/ORIGEN](https://scale.ornl.gov) library to solve nuclide inventory generation problems.
To install, use `pip`.
```console
pip install scale-olm
```
## Locations
The main development repository is hosted on [GitHub](https://github.com/wawiesel/olm)
with a read-only mirror on the ORNL-hosted [GitLab](https://code.ornl.gov/scale/code/olm).
## Developing
The script `dev.sh` is provided to initialize the development environment.
```console
$ git clone https://github.com/wawiesel/olm
$ cd olm
$ source dev.sh
```
This is all you should need to do. The following sections explain in more detail
what happens when you run `dev.sh`.
## Developer details
This section contains additional details on developing OLM.
### Enable virtual environment
```console
$ virtualenv venv
$ . venv/bin/activate
$ which python
```
If you get an error about missing `virtualenv`, you may need to install it.
```console
$ pip install virtualenv
```
### Install requirements
After enabling the virtual environment, run this command to install dependencies.
```console
$ pip install -r requirements.txt
```
NOTE: if you need to regenerate the requirements file after adding dependencies.
```console
$ 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`.
```console
$ 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.
```console
$ 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.
```console
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.
```console
$ 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](https://click.palletsprojects.com/en/8.1.x)
for command line. Here's a nice [video about click](https://www.youtube.com/watch?v=kNke39OZ2k0).
### Commit messages
Follow these [guidelines](https://cbea.ms/git-commit/) for commit messages.
### Version updates
OLM uses [semantic versioning](https://semver.org/). You should commit the
relevant code with the usual description commit message.
Then run
- `bumpversion patch` if you are fixing a bug
- `bumpversion minor` if you are adding a new feature
- `bumpversion major` if you are breaking backwards compatibility
When you push you need to `git push --tags` or configure your repo to always push tags:
```
#.git/config
[remote "origin"]
push = +refs/heads/*:refs/heads/*
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.
```console
$ pytest -n 6 .
```
### Black for commit formatting
The first time you do work on a clone, do this.
```console
$ pre-commit install
```
This will use the [Black formatter](https://medium.com/gousto-engineering-techbrunch/automate-python-code-formatting-with-black-and-pre-commit-ebc69dcc5e03).
### 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.
```console
$ pytest -v scale/olm/core.py
```
Raw data
{
"_id": null,
"home_page": "",
"name": "scale-olm",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "SCALE,ORIGEN,Library",
"author": "",
"author_email": "William Wieselquist <ww5@ornl.gov>",
"download_url": "https://files.pythonhosted.org/packages/59/4b/a97da269fb57440466d09d74bcf6c1da7d60cebb967077d78b4c1b371267/scale-olm-0.12.4.tar.gz",
"platform": null,
"description": "## ORIGEN Library Manager (OLM)\n\n[](https://scale-olm.readthedocs.io/en/v0.12.4)\n\nThis is version [v0.12.4](https://scale-olm.readthedocs.io/en/v0.12.4).\n\nOLM is a command-line utility that streamlines aspects of using the \n[SCALE/ORIGEN](https://scale.ornl.gov) library to solve nuclide inventory generation problems.\n\nTo install, use `pip`.\n\n```console\npip install scale-olm\n```\n\n## Locations\n\nThe main development repository is hosted on [GitHub](https://github.com/wawiesel/olm) \nwith a read-only mirror on the ORNL-hosted [GitLab](https://code.ornl.gov/scale/code/olm).\n\n## Developing\n\nThe script `dev.sh` is provided to initialize the development environment.\n\n```console\n$ git clone https://github.com/wawiesel/olm\n$ cd olm\n$ source dev.sh\n```\n\nThis is all you should need to do. The following sections explain in more detail \nwhat happens when you run `dev.sh`.\n\n## Developer details\n\nThis section contains additional details on developing OLM.\n\n### Enable virtual environment\n\n```console\n$ virtualenv venv\n$ . venv/bin/activate\n$ which python\n```\n\nIf you get an error about missing `virtualenv`, you may need to install it.\n\n```console\n$ pip install virtualenv\n```\n\n### Install requirements\n\nAfter enabling the virtual environment, run this command to install dependencies.\n\n```console\n$ pip install -r requirements.txt\n```\n\nNOTE: if you need to regenerate the requirements file after adding dependencies.\n```console\n$ pip freeze | grep -v '^\\-e'>requirements.txt\n```\n\n### Enable a local install for testing\n\nThis command will enable any changes you make to instantly propagate to the executable\nyou can run just with `olm`.\n\n```console\n$ pip install --editable .\n$ olm\n$ which olm\n```\n\n### Creating docs\n\nWith the development environment installed, the docs may be created within the\n`docs` directory. With the following commands.\n\n```console\n$ cd docs\n$ make html\n$ open build/html/index.html\n```\n\nAlternatively the PDF docs may be generated using the `make latexpdf` command. Note\nthat the HTML docs are intended as the main documentation.\n\nThe following greatly simplifies iterating on documentation. Run this command\nand open your browser to http://localhost:8000.\n\n```console\nsphinx-autobuild docs/source/ docs/build/html/\n```\n\n\n\n### Notebooks\n\nThere are notebooks contained in `notebooks` which may be helpful for debugging or\nunderstanding how something is working. You may need to install your virtual environment\nkernel for the notebooks to work. You should use the local `venv` kernel instead of\nyour default Python kernel so you have all the local packages at the correct versions.\n\n```console\n$ ipython kernel install --name \"venv\" --user\n```\n\nNow, you can select the created kernel \"venv\" when you start Jupyter notebook or lab.\n\n## Notes about development\n\n### Click for CLI\n\nWe use the [Click python library](https://click.palletsprojects.com/en/8.1.x)\nfor command line. Here's a nice [video about click](https://www.youtube.com/watch?v=kNke39OZ2k0).\n\n### Commit messages\n\nFollow these [guidelines](https://cbea.ms/git-commit/) for commit messages.\n\n### Version updates\n\nOLM uses [semantic versioning](https://semver.org/). You should commit the \nrelevant code with the usual description commit message. \n\nThen run \n\n- `bumpversion patch` if you are fixing a bug\n- `bumpversion minor` if you are adding a new feature\n- `bumpversion major` if you are breaking backwards compatibility\n\nWhen you push you need to `git push --tags` or configure your repo to always push tags:\n\n```\n#.git/config\n[remote \"origin\"]\n push = +refs/heads/*:refs/heads/*\n push = +refs/tags/*:refs/tags/*\n```\n\n### Pytest for unit tests\n\nLocally for unit tests we use the pytest framework under the `testing` directory.\nAll tests can be run simply like this from the root directory. Not we are using the\n`pytest-xdist` extension which allows parallel testing.\n\n```console\n$ pytest -n 6 .\n```\n\n### Black for commit formatting\n\nThe first time you do work on a clone, do this.\n\n```console\n$ pre-commit install\n```\n\nThis will use the [Black formatter](https://medium.com/gousto-engineering-techbrunch/automate-python-code-formatting-with-black-and-pre-commit-ebc69dcc5e03).\n\n\n### Docstrings and Doctest\n\nOur goal is to have each function, module, and class with standard docstrings and\na few doctests. You can run verbose tests on a specific module as follows.\n\n```console\n$ pytest -v scale/olm/core.py\n```\n",
"bugtrack_url": null,
"license": "Copyright 2024 UT-Battelle, LLC Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \u201cAS IS\u201d AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "ORIGEN Library Manager: A tool for building and managing ORIGEN reactor data libraries",
"version": "0.12.4",
"project_urls": {
"bug-tracker": "https://github.com/wawiesel/olm/issues",
"documentation": "https://scale-olm.readthedocs.io",
"source": "https://github.com/wawiesel/olm"
},
"split_keywords": [
"scale",
"origen",
"library"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aab93d17319f866e2423004ecf52a653224536de3ecdf8d055c16608b761ad0c",
"md5": "23c5041d7a9f75c79481de3531225b83",
"sha256": "246232a0a4d1023d499ffcf2046bd6e57766605711016def299a9ce5106f78fc"
},
"downloads": -1,
"filename": "scale_olm-0.12.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "23c5041d7a9f75c79481de3531225b83",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 75423,
"upload_time": "2024-02-16T03:25:12",
"upload_time_iso_8601": "2024-02-16T03:25:12.289470Z",
"url": "https://files.pythonhosted.org/packages/aa/b9/3d17319f866e2423004ecf52a653224536de3ecdf8d055c16608b761ad0c/scale_olm-0.12.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "594ba97da269fb57440466d09d74bcf6c1da7d60cebb967077d78b4c1b371267",
"md5": "72ce277c6034c7c1f7a323c16c36eb14",
"sha256": "edd277a6e12a2a38dea28734997fbaa21dbe3df6c233e33598c7cdaca1623bb5"
},
"downloads": -1,
"filename": "scale-olm-0.12.4.tar.gz",
"has_sig": false,
"md5_digest": "72ce277c6034c7c1f7a323c16c36eb14",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 76434,
"upload_time": "2024-02-16T03:25:13",
"upload_time_iso_8601": "2024-02-16T03:25:13.951144Z",
"url": "https://files.pythonhosted.org/packages/59/4b/a97da269fb57440466d09d74bcf6c1da7d60cebb967077d78b4c1b371267/scale-olm-0.12.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-16 03:25:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wawiesel",
"github_project": "olm",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "scale-olm"
}
