Osier
Osier: A Python package for multi-objective energy system optimization - Published in JOSS (2024)
Science Score: 95.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
1 of 4 committers (25.0%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Repository
Justice oriented energy system optimization framework
Basic Info
- Host: GitHub
- Owner: arfc
- License: bsd-3-clause
- Language: Python
- Default Branch: main
- Size: 6.73 MB
Statistics
- Stars: 6
- Watchers: 2
- Forks: 7
- Open Issues: 3
- Releases: 8
Metadata Files
README.md
osier
/ˈōZHər/
Open source multi-objective energy system framework
Installation
Method 1: PyPI
osier is available through PyPI. 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.
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.
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.
Credits
Some of the documentation infrastructure was inspired by and borrowed from the watts documentation.
Owner
- Name: Advanced Reactors and Fuel Cycles
- Login: arfc
- Kind: organization
- Email: arfc@groups.google.com
- Location: University of Illinois at Urbana-Champaign
- Website: https://arfc.github.io
- Repositories: 113
- Profile: https://github.com/arfc
A research group focused on modeling and simulation of advanced nuclear reactors and fuel cycles.
JOSS Publication
Osier: A Python package for multi-objective energy system optimization
Authors
Department of Nuclear, Plasma, and Radiological Engineering, University of Illinois Urbana-Champaign, USA
Department of Nuclear, Plasma, and Radiological Engineering, University of Illinois Urbana-Champaign, USA
Editor
Prashant Jha
Tags
energy systems genetic algorithms multi-objective optimizationGitHub Events
Total
- Create event: 1
- Release event: 1
- Issues event: 3
- Watch event: 1
- Issue comment event: 9
- Push event: 12
- Pull request review event: 14
- Pull request review comment event: 25
- Pull request event: 6
Last Year
- Create event: 1
- Release event: 1
- Issues event: 3
- Watch event: 1
- Issue comment event: 9
- Push event: 12
- Pull request review event: 14
- Pull request review comment event: 25
- Pull request event: 6
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Sam Dotson | s****n@g****m | 377 |
| Sam Dotson | s****n@O****l | 2 |
| yardasol | o****2@i****u | 1 |
| Fred Shone | 2****e | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 39
- Total pull requests: 37
- Average time to close issues: 6 months
- Average time to close pull requests: 7 days
- Total issue authors: 6
- Total pull request authors: 3
- Average comments per issue: 0.67
- Average comments per pull request: 2.46
- Merged pull requests: 35
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 4
- Pull requests: 12
- Average time to close issues: 3 months
- Average time to close pull requests: 9 days
- Issue authors: 2
- Pull request authors: 3
- Average comments per issue: 1.0
- Average comments per pull request: 1.75
- Merged pull requests: 11
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- samgdotson (27)
- fredshone (4)
- ceserz2 (3)
- victoraalves (2)
- abachma2 (2)
Pull Request Authors
- samgdotson (43)
- fredshone (2)
- ceserz2 (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 58 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 10
- Total maintainers: 1
pypi.org: osier
osier: A justice oriented energy system optimization tool
- Homepage: https://osier.readthedocs.io
- Documentation: https://osier.readthedocs.io/
- 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.
-
Latest release: 0.4.1
published 7 months ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- conda-incubator/setup-miniconda v2 composite
- deap *
- dill *
- matplotlib *
- nrelpy *
- numpy *
- openpyxl *
- pandas *
- pyentrp *
- pymoo *
- pyomo *
- pytest *
- unyt *
- deap *
- dill *
- openpyxl *
- osier *
- pyentrp *
- pymoo *