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
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 0 additions & 2 deletions .coveragerc

This file was deleted.

7 changes: 3 additions & 4 deletions .github/workflows/pytest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ jobs:
matrix:
python-version: ["3.9", "3.10", "3.11"]
env: [
'-r requirements.txt .[test]',
'--upgrade --upgrade-strategy=eager .[test]'
]

Expand All @@ -28,8 +27,8 @@ jobs:
python-version: ${{ matrix.python-version }}
- name: Install ${{ matrix.env }}
run: |
python -m pip install --upgrade pip wheel
pip install ${{ matrix.env }}
python -m pip install --progress-bar off --upgrade pip
python -m pip install --progress-bar off ${{ matrix.env }}
- name: Test with pytest ${{ matrix.env }}
run: |
pytest
python -m pytest
4 changes: 1 addition & 3 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
include versioneer.py
include pvdeg/_version.py
include pvdeg/data/*
include LICENSE
include *.md
graft DataLibrary
30 changes: 13 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
Expand Down
11 changes: 11 additions & 0 deletions contributors/markcampanelli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
2024-01-09

I hereby agree to the terms of the Contributors License Agreement,
version 1.0, with MD5 checksum 46ea45f996295bdb0652333d516a6d0a.

I furthermore declare that I am authorized and able to make this
agreement and sign this declaration.

Signed,

Mark Campanelli https://github.com/markcampanelli
25 changes: 19 additions & 6 deletions docs/sphinx/source/_autosummary/pvdeg.collection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,30 @@

.. automodule:: pvdeg.collection












.. rubric:: Functions

.. autosummary::

calculate_jsc_from_tau_cp
calculate_jsc_from_tau_iqe
collection_probability
generation_current













25 changes: 19 additions & 6 deletions docs/sphinx/source/_autosummary/pvdeg.degradation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,31 @@

.. automodule:: pvdeg.degradation












.. rubric:: Functions

.. autosummary::

IwaArrhenius
IwaVantHoff
arrhenius_deg
degradation
vantHoff_deg













23 changes: 18 additions & 5 deletions docs/sphinx/source/_autosummary/pvdeg.design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,28 @@

.. automodule:: pvdeg.design







.. rubric:: Functions

.. autosummary::

edge_seal_ingress_rate
edge_seal_width












.. rubric:: Functions

.. autosummary::

edge_seal_ingress_rate
edge_seal_width
21 changes: 17 additions & 4 deletions docs/sphinx/source/_autosummary/pvdeg.fatigue.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,27 @@

.. automodule:: pvdeg.fatigue







.. rubric:: Functions

.. autosummary::

solder_fatigue












.. rubric:: Functions

.. autosummary::

solder_fatigue
26 changes: 19 additions & 7 deletions docs/sphinx/source/_autosummary/pvdeg.humidity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@

.. automodule:: pvdeg.humidity












.. rubric:: Functions

.. autosummary::

Ce_numba
back_encap
backsheet
Expand All @@ -21,5 +21,17 @@
front_encap
module
psat
run_module
surface_outside













25 changes: 19 additions & 6 deletions docs/sphinx/source/_autosummary/pvdeg.letid.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@

.. automodule:: pvdeg.letid












.. rubric:: Functions

.. autosummary::

calc_device_params
calc_dn
calc_energy_loss
Expand All @@ -30,3 +30,16 @@
j0_gray
k_ij
tau_now













23 changes: 18 additions & 5 deletions docs/sphinx/source/_autosummary/pvdeg.spectral.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,28 @@

.. automodule:: pvdeg.spectral







.. rubric:: Functions

.. autosummary::

poa_irradiance
solar_position












.. rubric:: Functions

.. autosummary::

poa_irradiance
solar_position
24 changes: 18 additions & 6 deletions docs/sphinx/source/_autosummary/pvdeg.standards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,28 @@

.. automodule:: pvdeg.standards







.. rubric:: Functions

.. autosummary::

eff_gap
standoff












.. rubric:: Functions

.. autosummary::

calc_standoff
eff_gap
run_calc_standoff
Loading
Loading