Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

osier

Justice oriented energy system optimization framework.
https://github.com/arfc/osier

Category: Energy Systems
Sub Category: Energy System Modeling Frameworks

Last synced: about 16 hours ago
JSON representation

Repository metadata

Justice oriented energy system optimization framework

README.md

osier

/ˈōZHər/
Open source multi-objective energy system framework

status
Build Status
Documentation Status
Binder

Installation

Method 1: PyPI

osier is available through PyPI. It may be installed with

python -m pip install osier

or by cloning this repository and building from source:

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.

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:

cd osier/docs
make html
cd build/html
# to serve the documentation
python -m http.server

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.

Binder

Tests

osier's tests can be run by executing pytest in the top-level directory
of osier.

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 metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 4 days ago

Total Commits: 383
Total Committers: 4
Avg Commits per committer: 95.75
Development Distribution Score (DDS): 0.01

Commits in past year: 5
Committers in past year: 1
Avg Commits per committer in past year: 5.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
Sam Dotson s****n@g****m 379
Sam Dotson s****n@O****l 2
yardasol o****2@i****u 1
Fred Shone 2****e 1

Committer domains:

Issue and Pull Request metadata

Last synced: 2 months ago

Total issues: 38
Total pull requests: 49
Average time to close issues: 5 months
Average time to close pull requests: 11 days
Total issue authors: 5
Total pull request authors: 3
Average comments per issue: 0.74
Average comments per pull request: 2.49
Merged pull request: 44
Bot issues: 0
Bot pull requests: 0

Past year issues: 0
Past year pull requests: 5
Past year average time to close issues: N/A
Past year average time to close pull requests: 28 days
Past year issue authors: 0
Past year pull request authors: 1
Past year average comments per issue: 0
Past year average comments per pull request: 0.6
Past year merged pull request: 5
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/arfc/osier

Top Issue Authors

  • samgdotson (27)
  • fredshone (4)
  • ceserz2 (3)
  • victoraalves (2)
  • abachma2 (2)

Top Pull Request Authors

  • samgdotson (45)
  • fredshone (2)
  • ceserz2 (2)

Top Issue Labels

  • Status:1-New (21)
  • Comp:Core (15)
  • Priority:2-Normal (14)
  • Type:Feature (14)
  • Difficulty:1-Beginner (13)
  • Difficulty:3-Expert (12)
  • Comp:Build (11)
  • Priority:1-Critical (10)
  • Type:Docs (8)
  • Type:Bug (8)
  • Difficulty:2-Challenging (6)
  • Type:Test (4)
  • Priority:3-Desired (4)
  • Priority:4-Low (3)
  • Status:2-Backlog (3)
  • Status:7-WontFix (3)
  • Type:Style (2)
  • Comp:Input (2)
  • Status:3-Selected (2)
  • Status:5-In Review (2)
  • Status:4-In Progress (2)
  • Comp:Analysis (1)
  • Comp:Output (1)

Top Pull Request Labels

  • Status:5-In Review (31)
  • Priority:1-Critical (29)
  • Comp:Core (19)
  • Difficulty:2-Challenging (17)
  • Type:Feature (17)
  • Type:Docs (14)
  • Difficulty:1-Beginner (13)
  • Comp:Build (12)
  • Type:Bug (6)
  • Type:Test (5)
  • Difficulty:3-Expert (4)
  • Priority:2-Normal (4)
  • Comp:Output (4)
  • Type:Style (2)

Package metadata

pypi.org: osier

osier: A justice oriented energy system optimization tool

  • Homepage: https://osier.readthedocs.io
  • Documentation: https://osier.readthedocs.io/
  • Licenses: 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.2 (published 6 months ago)
  • Last Synced: 2026-05-23T18:01:02.849Z (4 days ago)
  • Versions: 11
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 69 Last month
  • Rankings:
    • Dependent packages count: 6.633%
    • Forks count: 19.553%
    • Average: 23.033%
    • Downloads: 26.046%
    • Dependent repos count: 30.611%
    • Stargazers count: 32.321%
  • Maintainers (1)

Dependencies

.github/workflows/CI.yml actions
  • actions/checkout v3 composite
  • conda-incubator/setup-miniconda v2 composite
pyproject.toml pypi
  • deap *
  • dill *
  • matplotlib *
  • nrelpy *
  • numpy *
  • openpyxl *
  • pandas *
  • pyentrp *
  • pymoo *
  • pyomo *
  • pytest *
  • unyt *
environment.yml pypi
  • deap *
  • dill *
  • openpyxl *
  • osier *
  • pyentrp *
  • pymoo *

Score: 8.03268487596762