Skip to content

Commit e9b5810

Browse files
authored
package metadata and doc build updates (#17)
* remove pvlib and pandas from install_requires * update project metadata URLs to point to pvlib github organization * rework doc requirements and build * correct license name in setup.cfg * add missing pvlib command in readme * doc reqs tweaks * update package descriptions * d'oh
1 parent 860208c commit e9b5810

File tree

4 files changed

+24
-32
lines changed

4 files changed

+24
-32
lines changed

.readthedocs.yml

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
version: 2
22

3-
conda:
4-
environment: docs/environment.yml
53

64
build:
7-
image: latest
5+
os: ubuntu-20.04
6+
tools:
7+
python: "3.7"
88

9-
# This part is necessary otherwise the project is not built
109
python:
11-
version: 3.7
10+
# only use the packages specified in setup.py
11+
system_packages: false
12+
1213
install:
1314
- method: pip
1415
path: .
15-
16-
# By default readthedocs does not checkout git submodules
17-
submodules:
18-
include: all
16+
extra_requirements:
17+
- doc

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Open source code for calculating self-shading of two-axis tracking solar collectors
2-
"twoaxistracking" is a python package for simulating self-shading in fields of two-axis trackers.
2+
twoaxistracking is a python package for simulating two-axis tracking solar collectors, particularly self-shading.
33

44
## Documentation
55
The documentation can be found at [readthedocs](https://twoaxistracking.readthedocs.io/).
@@ -15,6 +15,8 @@ The main non-standard dependency is `shapely`, which handles the geometric opera
1515

1616
The solar modeling library `pvlib` is recommended for calculating the solar position and can be installed by the command:
1717

18+
pip install pvlib
19+
1820
## Citing
1921
If you use the package in published work, please cite:
2022
> Adam R. Jensen et al. 2022.

docs/environment.yml

Lines changed: 0 additions & 15 deletions
This file was deleted.

setup.cfg

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ name = twoaxistracking
33
version = 0.1.0
44
author = Adam R. Jensen
55
author_email = [email protected]
6-
description = Functions for simulating self-shading of two-axis trackers
6+
description = twoaxistracking is a python package for simulating two-axis tracking solar collectors, particularly self-shading.
77
long_description = file: README.md
88
long_description_content_type = text/markdown
9-
url = https://github.com/AdamRJensen/twoaxistracking
9+
url = https://github.com/pvlib/twoaxistracking
1010
project_urls =
11-
Bug Tracker = https://github.com/AdamRJensen/twoaxistracking/issues
11+
Bug Tracker = https://github.com/pvlib/twoaxistracking/issues
1212
classifiers =
1313
Programming Language :: Python :: 3
14-
License :: OSI Approved :: MIT License
14+
License :: OSI Approved :: BSD License
1515
Operating System :: OS Independent
1616
Topic :: Scientific/Engineering
1717
Intended Audience :: Science/Research
@@ -20,14 +20,20 @@ classifiers =
2020
packages = twoaxistracking
2121
python_requires = >=3.7
2222
install_requires =
23-
pvlib
2423
numpy
25-
pandas
2624
matplotlib
2725
shapely
2826

2927
[options.extras_require]
30-
test = pytest;pytest-cov;
28+
test =
29+
pytest
30+
pytest-cov
31+
doc =
32+
sphinx==4.4.0
33+
myst-nb==0.13.2
34+
sphinx-book-theme==0.2.0
35+
pvlib==0.9.0
36+
pandas==1.3.5
3137

3238
[tool:pytest]
3339
addopts = --cov=twoaxistracking --cov-fail-under=100 --cov-report=term-missing

0 commit comments

Comments
 (0)