Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Zhanwei-Liu committed Jul 4, 2024
1 parent c0f5ee2 commit 607e410
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ The clean energy transition is our new moonshot to combat climate change – an
- Optimization model based on linear programming for multi-zone energy systems.
- Cost minimization while meeting given demand time series.
- Adjustable operation on hourly-spaced time steps.
- Input data in Excel format and output data in NetCDF format using ``Xarray``.
- Support for multiple solvers like ``Gurobi``, ``COPT``, ``MOSEK``, and ``HIGHS`` via `pyoptinterface`.
- Input data in Excel format and output data in ``NetCDF`` format using [Xarray](https://docs.xarray.dev/en/stable/).
- Support for multiple solvers like [HiGHS](https://github.com/jump-dev/HiGHS.jl) , [GUROBI](https://www.gurobi.com/), [COPT](https://www.copt.de/), and [MOSEK](https://www.mosek.com/) via [PyOptInterface](https://github.com/metab0t/PyOptInterface).
- Allows input of multiple scenarios for specific parameters.
- A pure Python program, leveraging ``pandas`` and ``Xarray`` for simplified complex data analysis and extensibility.
- A pure Python program, leveraging [pandas](https://pandas.pydata.org/) and [Xarray](https://docs.xarray.dev/en/stable/) for simplified complex data analysis and extensibility.

## Getting Started

Expand All @@ -63,7 +63,7 @@ This section includes a brief tutorial on running your first PREP-SHOT model.
3. Activate the Conda Environment

```bash
conda activate prep-shot-test
conda activate prep-shot
```

4. Run your first model
Expand All @@ -74,6 +74,12 @@ This section includes a brief tutorial on running your first PREP-SHOT model.

This example is inspired by real-world data. For a detailed elaboration of this tutorial, check out the [Tutorial Page](https://prep-next.github.io/PREP-SHOT/Tutorial.html) in our documentation.

By default, PREP-SHOT uses open-source freely ``HIGHS`` solver. Solver-specific settings parameters are specified in the ``config.json`` file, which should be located in the current working directory. We also provide the option to use one of these three commercial solvers:

+ [Gurobi](https://www.gurobi.com/)
+ [COPT](https://www.copt.de/)
+ [MOSEK](https://www.mosek.com/)

## How to Contribute

To contribute to this project, please read our [Contributing Guidelines](https://prep-next.github.io/PREP-SHOT/Changelog.html#contributing-to-prep-shot).
Expand Down Expand Up @@ -103,8 +109,8 @@ Please use the GitHub Issues for public discussions related to bugs, enhancement
## Roadmap
- [x] `Benders` decomposition-based fast solution framework
- [x] [`pyoptinterface`](https://github.com/metab0t/PyOptInterface)-based low-memory and fast modelling engine
- [ ] Support for input of cost–supply curves of technologies
- [x] [`PyOptInterface`](https://github.com/metab0t/PyOptInterface)-based low-memory and fast modelling engine
- [x] Support for input of cost–supply curves of technologies
- [ ] Support for expanding conventional hydropower plants
- [ ] Support for refurbishing conventional hydropower plants to pumped-storage schemes
- [ ] Support for refurbishing carbon-emission plants to carbon capture and storage (CCS) schemes
Expand Down
6 changes: 3 additions & 3 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ Key Features
* PREP-SHOT is an optimization model based on linear programming for energy systems with multiple zones.
* It aims to minimize costs while meeting the given demand time series.
* By default, it operates on hourly-spaced time steps, but this can be adjusted.
* The input data is in Excel format, while output data is generated in a NetCDF format using ``Xarray``.
* It supports multiple types of solvers such as Gurobi, CPLEX, MOSEK, and GLPK via `Pyomo <https://pyomo.readthedocs.io/en/stable/solving_pyomo_models.html>`_.
* The input data is in Excel format, while output data is generated in a NetCDF format using `Xarray <https://docs.xarray.dev/en/stable/>`_.
* It supports multiple types of solvers such as `HiGHS <https://github.com/jump-dev/HiGHS.jl>`_ , `GUROBI <https://www.gurobi.com/>`_, `COPT <https://www.copt.de/>`_, and `MOSEK <https://www.mosek.com/>`_ via `PyOptInterface <https://github.com/metab0t/PyOptInterface>`_.
* It allows the input of multiple scenarios for specific parameters.
* As a pure Python program, it benefits from the use of ``pandas`` and ``Xarray``, simplifying complex data analysis and promoting extensibility.
* As a pure Python program, it benefits from the use of `pandas <https://pandas.pydata.org/>`_ and `Xarray <https://docs.xarray.dev/en/stable/>`_, simplifying complex data analysis and promoting extensibility.

Offline documentation
----------------------
Expand Down

0 comments on commit 607e410

Please sign in to comment.