Skip to content

Commit

Permalink
Update README and installation documentation for clarity and complete…
Browse files Browse the repository at this point in the history
…ness
  • Loading branch information
boyuan276 committed Dec 13, 2024
1 parent e98876e commit 21e2747
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,41 @@ It contains the following components:
* Battery storage
* Electric vehicle (EV) charging

## Documentation

Full documentation can be found at [readthedocs](https://nygrid-python.readthedocs.io/en/latest/).

## Installation

### Install using pip

The ``nygrid`` package can be installed using PIP.

```bash
pip install nygrid
```

### Install from the source

1. Install [Anaconda](https://www.anaconda.com/download/).

2. Install [Git](https://git-scm.com/downloads).

3. Clone the repository:
```bash
git clone https://github.com/boyuan276/NYgrid-python.git
```

4. Create a conda environment:
```bash
conda env create -f NYgrid-python.yml
```

5. Activate the environment:
```bash
conda activate NYgrid-python
```

6. Install the package:
```bash
pip install -e .
Expand Down Expand Up @@ -75,6 +94,10 @@ conda activate NYgrid-python

2. Load data: See `examples/write_load_profiles_{case_name}.ipynb`.

## License

MIT license.


## See also
* [MATLAB version of the NYgrid model](https://github.com/AndersonEnergyLab-Cornell/NYgrid.git)
9 changes: 9 additions & 0 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
Installation
============

Install using pip
-----------------

The ``nygrid`` package can be installed using pip::
pip install nygrid

Install from source
-------------------

1. Install `Anaconda <https://www.anaconda.com/download/>`_.

2. Install `Git <https://git-scm.com/downloads>`_.
Expand Down

0 comments on commit 21e2747

Please sign in to comment.