| Name | osier JSON |
| Version |
0.4.1
JSON |
| download |
| home_page | None |
| Summary | osier: A justice oriented energy system optimization tool |
| upload_time | 2025-07-16 21:32:29 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | BSD 3-Clause License
Copyright (c) 2022-2025, Advanced Reactors and Fuel Cycles
All rights reserved.
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 |
energy systems
optimization
multi-objective
justice
multi-criteria decision
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# osier
/ˈōZHər/ <br>
Open source multi-objective energy system framework
[](https://joss.theoj.org/papers/183a04edba2d4952fa1e30c419a844b3)
[](https://github.com/arfc/osier/actions/workflows/CI.yml)
[](https://osier.readthedocs.io/en/latest/?badge=latest)
[](https://mybinder.org/v2/gh/samgdotson/osier/env-instructions?labpath=docs%2Fsource%2Fexamples)
## Installation
### Method 1: PyPI
`osier` is available through [PyPI](https://pypi.org/project/osier/). It may be installed with
```bash
python -m pip install osier
```
or by cloning this repository and building from source:
```bash
git clone git@github.com:arfc/osier.git # requires ssh-keys
# or
git clone https://github.com/arfc/osier.git
cd osier
# for a basic installation
pip install .
# (Windows/Linux) to also install the documentation dependencies
pip install .[doc]
# (MacOS)
pip install .'[doc]'
```
### Method 2: Conda/Mamba Environment
Although `osier` is not yet available on `conda-forge`, you may have a more consistent experience by installing
`osier` via a `conda` environment.
```bash
git clone git@github.com:arfc/osier.git # requires ssh-keys
mamba env create # mamba and conda are interchangeable, here
mamba activate osier-env
```
## Documentation
The documentation for `osier` can be viewed [here](https://osier.readthedocs.io/en/latest/).
You can also build the docs locally with:
```bash
cd osier/docs
make html
cd build/html
# to serve the documentation
python -m http.server
```
```{note}
Users attempting a local install need to make sure that they have `pandoc` installed.
Please visit [`pandoc`'s documentation](https://pandoc.org/installing.html) for
instructions.
```
## Examples
The examples can be found in the `docs/source/examples/` directory. Alternatively,
users can run the notebooks and experiment with `osier` through the Binder app.
[](https://mybinder.org/v2/gh/samgdotson/osier/env-instructions?labpath=docs%2Fsource%2Fexamples)
## Tests
`osier`'s tests can be run by executing `pytest` in the top-level directory
of `osier`.
```{note}
The test package assumes the user has `coin-or-cbc` installed as the default solver. For Windows machines,
this may require some additional steps to install the solver. [Here](https://stackoverflow.com/questions/58868054/how-to-install-coincbc-using-conda-in-windows) is a helpful place to start.
```
## Contributing
Contributions to `osier` are welcome. For details on how to make bug reports, pull requests, and other information, check the [contributing page](docs/source/contrib.md).
## Credits
Some of the documentation infrastructure was inspired by and borrowed from the [`watts` documentation](https://watts.readthedocs.io/en/latest/index.html).
Raw data
{
"_id": null,
"home_page": null,
"name": "osier",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Sam Dotson <samgdotson@gmail.com>",
"keywords": "energy systems, optimization, multi-objective, justice, multi-criteria decision",
"author": null,
"author_email": "Sam Dotson <samgdotson@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a5/fe/ada26216bd083a115fd959a44f1011aed827a3bc7916f43645ec43e8e340/osier-0.4.1.tar.gz",
"platform": null,
"description": "# osier\n/\u02c8\u014dZH\u0259r/ <br>\nOpen source multi-objective energy system framework\n\n[](https://joss.theoj.org/papers/183a04edba2d4952fa1e30c419a844b3)\n[](https://github.com/arfc/osier/actions/workflows/CI.yml)\n[](https://osier.readthedocs.io/en/latest/?badge=latest)\n[](https://mybinder.org/v2/gh/samgdotson/osier/env-instructions?labpath=docs%2Fsource%2Fexamples)\n\n\n## Installation\n\n### Method 1: PyPI\n\n`osier` is available through [PyPI](https://pypi.org/project/osier/). It may be installed with \n```bash\npython -m pip install osier\n``` \nor by cloning this repository and building from source:\n\n```bash\ngit clone git@github.com:arfc/osier.git # requires ssh-keys\n# or\ngit clone https://github.com/arfc/osier.git\ncd osier\n# for a basic installation\npip install .\n# (Windows/Linux) to also install the documentation dependencies\npip install .[doc]\n# (MacOS)\npip install .'[doc]'\n```\n\n### Method 2: Conda/Mamba Environment\n\nAlthough `osier` is not yet available on `conda-forge`, you may have a more consistent experience by installing\n`osier` via a `conda` environment.\n\n```bash\ngit clone git@github.com:arfc/osier.git # requires ssh-keys\nmamba env create # mamba and conda are interchangeable, here\nmamba activate osier-env\n```\n\n\n## Documentation\nThe documentation for `osier` can be viewed [here](https://osier.readthedocs.io/en/latest/). \nYou can also build the docs locally with:\n\n```bash\ncd osier/docs\nmake html\ncd build/html\n# to serve the documentation\npython -m http.server\n```\n\n```{note}\nUsers attempting a local install need to make sure that they have `pandoc` installed.\nPlease visit [`pandoc`'s documentation](https://pandoc.org/installing.html) for \ninstructions.\n```\n\n## Examples\n\nThe examples can be found in the `docs/source/examples/` directory. Alternatively, \nusers can run the notebooks and experiment with `osier` through the Binder app.\n\n[](https://mybinder.org/v2/gh/samgdotson/osier/env-instructions?labpath=docs%2Fsource%2Fexamples)\n\n\n## Tests\n`osier`'s tests can be run by executing `pytest` in the top-level directory \nof `osier`.\n\n```{note}\nThe test package assumes the user has `coin-or-cbc` installed as the default solver. For Windows machines,\nthis may require some additional steps to install the solver. [Here](https://stackoverflow.com/questions/58868054/how-to-install-coincbc-using-conda-in-windows) is a helpful place to start.\n```\n\n\n## Contributing\n\nContributions to `osier` are welcome. For details on how to make bug reports, pull requests, and other information, check the [contributing page](docs/source/contrib.md).\n\n\n## Credits\nSome of the documentation infrastructure was inspired by and borrowed from the [`watts` documentation](https://watts.readthedocs.io/en/latest/index.html).\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License\n \n Copyright (c) 2022-2025, Advanced Reactors and Fuel Cycles\n All rights reserved.\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n 1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n 2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n 3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n ",
"summary": "osier: A justice oriented energy system optimization tool",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://osier.readthedocs.io",
"Issues": "https://github.com/arfc/osier/issues",
"Repository": "https://github.com/arfc/osier"
},
"split_keywords": [
"energy systems",
" optimization",
" multi-objective",
" justice",
" multi-criteria decision"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "acb29b7e452f1b2b72958e9f96a715ebf9a6e2300ca7213767c08345eaa7a83f",
"md5": "92787b8a472b202d69dd4207eda1e90a",
"sha256": "3848f2464dc767995087e9066fe7d2a8d6a9df83df3bd7f723ed1fb241b47d94"
},
"downloads": -1,
"filename": "osier-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "92787b8a472b202d69dd4207eda1e90a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 21113,
"upload_time": "2025-07-16T21:32:28",
"upload_time_iso_8601": "2025-07-16T21:32:28.495012Z",
"url": "https://files.pythonhosted.org/packages/ac/b2/9b7e452f1b2b72958e9f96a715ebf9a6e2300ca7213767c08345eaa7a83f/osier-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a5feada26216bd083a115fd959a44f1011aed827a3bc7916f43645ec43e8e340",
"md5": "b144d8bbc4dc8c8e5fd3762a6fc429d8",
"sha256": "e2000db597e8f97ab9d7bcf34fd6f84c7078f1e9e629cce4ce5ae18e0893346e"
},
"downloads": -1,
"filename": "osier-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "b144d8bbc4dc8c8e5fd3762a6fc429d8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 29519,
"upload_time": "2025-07-16T21:32:29",
"upload_time_iso_8601": "2025-07-16T21:32:29.904425Z",
"url": "https://files.pythonhosted.org/packages/a5/fe/ada26216bd083a115fd959a44f1011aed827a3bc7916f43645ec43e8e340/osier-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-16 21:32:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "arfc",
"github_project": "osier",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "osier"
}
