fairyfly-core
Fairyfly is a collection of Python libraries to create representations of construction details following fairyfly-schema.
This package is the core library that provides fairyfly's common functionalities. To extend these functionalities you should install available Fairyfly extensions or write your own.
Here are a number of frequently used extensions for Fairyfly:
- fairyfly-therm: Adds LBNL THERM simulation to Fairyfly.
Installation
To install the core library use:
pip install -U fairyfly-core
To check if Fairyfly command line interface is installed correctly use fairyfly viz and you
should get a viiiiiiiiiiiiizzzzzzzzz! back in response! 🐝
API Documentation
Local Development
- Clone this repo locally
git clone git@github.com:ladybug-tools/fairyfly-core.git
# or
git clone https://github.com/ladybug-tools/fairyfly-core.git
- Install dependencies:
cd fairyfly-core
pip install -r dev-requirements.txt
pip install -r requirements.txt
- Run Tests:
python -m pytest ./tests
- Generate Documentation:
sphinx-apidoc -f -e -d 4 -o ./docs ./fairyfly
sphinx-build -b html ./docs ./docs/_build/docs
1 maintainer
Metadata
1 maintainer
Release files for fairyfly-core 0.2.41
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fairyfly_core-0.2.41.tar.gz | 56.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fairyfly_core-0.2.41-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 120.3 kB
Release files / fairyfly_core-0.2.41.tar.gz
| Download URL | fairyfly_core-0.2.41.tar.gz |
|---|---|
| Size | 56.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bba151569e3e34b8c073e348dbd2873368aceda2831ffc6a661c7a9a44d4eba1
|
|
BLAKE2b-256 checksum How to use checksums |
058fb59c7d150b0615a6be7ad0f79a852d802e8343ae903eee8cae3f13423200
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.14
|
Release files / fairyfly_core-0.2.41-py3-none-any.whl
| Download URL | fairyfly_core-0.2.41-py3-none-any.whl |
|---|---|
| Size | 63.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c92bde517ce451c059fac4f2037915fa50358b3af997975f5e0b53ad0645a257
|
|
BLAKE2b-256 checksum How to use checksums |
7b43f10b4c72d7dd8729d02f6a2506f681531450bbe75c0b5b1e445609198d64
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.14
|
