Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pyproject.toml for builds, using setuptools_scm for versioning #37

Merged
merged 8 commits into from
Jan 30, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update READMEs
markcampanelli committed Jan 11, 2024
commit 79b85065cbb7491930797bcef30b633501a1192a
30 changes: 13 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -50,28 +50,24 @@ It takes a minute to load the environment.

### Locally

You can also run the tutorial locally with
[miniconda](https://docs.conda.io/en/latest/miniconda.html) by following thes
steps:

1. Install [miniconda](https://docs.conda.io/en/latest/miniconda.html).

1. Clone the repository:
You can also run the tutorial locally in a virtual environment, i.e., `venv` or
[miniconda](https://docs.conda.io/en/latest/miniconda.html).

1. Create and activate a new environment, e.g., on Mac/Linux terminal with `venv`:
```
git clone https://github.com/NREL/PVDegradationTools.git
python -m venv pvdeg
. pvdeg/bin/activate
```

1. Create the environment and install the requirements. The repository includes
a `requirements.txt` file that contains a list the packages needed to run
this tutorial. To install them using conda run:

or with `conda`:
```
conda create -n pvdeg jupyter -c pvlib --file requirements.txt
conda create -n pvdeg
conda activate pvdeg
```

or you can install it with `pip install pvdeg` as explained in the installation instructions into the environment.
1. Install `pvdeg` into the new environment with `pip`:
```
python -m pip install pvdeg
```

1. Start a Jupyter session:

@@ -98,9 +94,9 @@ Install with:

pip install pvdeg

For developer installation, download the repository, navigate to the folder location and install as:
For developer installation, clone the repository, navigate to the folder location and install as:

pip install -e .
pip install -e .[all]


License
26 changes: 11 additions & 15 deletions pvdeg_tutorials/README.md
Original file line number Diff line number Diff line change
@@ -16,28 +16,24 @@ It takes a minute to load the environment.

### Locally

You can also run the tutorial locally with
[miniconda](https://docs.conda.io/en/latest/miniconda.html) by following thes
steps:

1. Install [miniconda](https://docs.conda.io/en/latest/miniconda.html).

1. Clone the repository:
You can also run the tutorial locally in a virtual environment, i.e., `venv` or
[miniconda](https://docs.conda.io/en/latest/miniconda.html).

1. Create and activate a new environment, e.g., on Mac/Linux terminal with `venv`:
```
git clone https://github.com/NREL/PVDegradationTools.git
python -m venv pvdeg
. pvdeg/bin/activate
```

1. Create the environment and install the requirements. The repository includes
a `requirements.txt` file that contains a list the packages needed to run
this tutorial. To install them using conda run:

or with `conda`:
```
conda create -n pvdeg jupyter -c conda-forge --file requirements.txt
conda create -n pvdeg
conda activate pvdeg
```

or you can install it with `pip install pvdeg` as explained in the installation instructions into the environment.
1. Install `pvdeg` into the new environment with `pip`:
```
python -m pip install pvdeg
```

1. Start a Jupyter session: