forked from ladybug-tools/ladybug
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci(dev-deps): Update CI and dev deps to run on Python 3.12
- Loading branch information
1 parent
2a8359f
commit 227ed20
Showing
5 changed files
with
99 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,8 +20,13 @@ For the Legacy Ladybug Grasshopper Plugin see [this repository](https://github.c | |
|
||
## Installation | ||
|
||
To install the library use: | ||
|
||
`pip install ladybug-core` | ||
|
||
To check if Honeybee command line interface is installed correctly use `ladybug viz` and you | ||
should get a `viiiiiiiiiiiiizzzzzzzzz!` back in response! | ||
|
||
## Usage | ||
|
||
```python | ||
|
@@ -45,6 +50,33 @@ print('altitude: {}, azimuth: {}'.format(sun.altitude, sun.azimuth)) | |
>>> altitude: 72.26, azimuth: 32.37 | ||
``` | ||
|
||
## Local Development | ||
1. Clone this repo locally | ||
```console | ||
git clone [email protected]:ladybug-tools/ladybug-core.git | ||
|
||
# or | ||
|
||
git clone https://github.com/ladybug-tools/ladybug.git | ||
``` | ||
2. Install dependencies: | ||
```console | ||
cd ladybug | ||
pip install -r dev-requirements.txt | ||
pip install -r requirements.txt | ||
``` | ||
|
||
3. Run Tests: | ||
```console | ||
python -m pytest ./tests | ||
``` | ||
|
||
4. Generate Documentation: | ||
```console | ||
sphinx-apidoc -f -e -d 4 -o ./docs ./ladybug | ||
sphinx-build -b html ./docs ./docs/_build/docs | ||
``` | ||
|
||
### Derivative Work | ||
|
||
Ladybug is a derivative work of the following software projects: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,18 @@ | ||
coverage==5.5 | ||
coveralls==1.7.0;python_version<'3.0' | ||
coveralls==2.2.0;python_version>='3.6' | ||
pytest==4.6.9;python_version<'3.0' | ||
pytest==6.2.4;python_version>='3.6' | ||
pytest-cov==2.12.0 | ||
Sphinx==1.8.5;python_version<'3.0' | ||
Sphinx==5.3.0;python_version>='3.6' | ||
docutils==0.17;python_version>='3.6' | ||
pytest==8.3.2;python_version>='3.6' | ||
Sphinx==8.0.2;python_version>='3.6' | ||
sphinx-bootstrap-theme==0.8.1 | ||
sphinxcontrib-fulltoc==1.2.0 | ||
sphinxcontrib-websupport==2.0.0;python_version>='3.6' | ||
sphinx-click==6.0.0;python_version>='3.6' | ||
twine==5.1.1;python_version>='3.6' | ||
wheel==0.44.0;python_version>='3.6' | ||
setuptools==75.1.0;python_version>='3.6' | ||
importlib-metadata==8.5.0;python_version>='3.6' | ||
pytest==4.6.9;python_version<'3.0' | ||
Sphinx==1.8.5;python_version<'3.0' | ||
sphinxcontrib-websupport==1.1.2;python_version<'3.0' | ||
sphinxcontrib-websupport==1.2.4;python_version>='3.6' | ||
sphinx-click==4.4.0 | ||
sphinx-click==4.4.0;python_version<'3.0' | ||
twine==1.13.0;python_version<'3.0' | ||
twine==3.4.1;python_version>='3.6' | ||
wheel==0.38.1 | ||
wheel==0.38.1;python_version<'3.0' | ||
setuptools==44.1.0;python_version<'3.0' | ||
setuptools==65.5.1;python_version>='3.6' | ||
importlib-metadata==2.0.0;python_version<'3.0' | ||
importlib-metadata==4.8.0;python_version>='3.6' | ||
jinja2==3.0.3;python_version>='3.6' | ||
markupsafe==2.0.1;python_version>='3.6' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters