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! :bee:
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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fairyfly_core-0.2.35.tar.gz.
File metadata
- Download URL: fairyfly_core-0.2.35.tar.gz
- Upload date:
- Size: 56.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
db4859a0c02120dc90af9e26cdce468846e1fcc0626b7b6588f68dc92862ae64
|
|
| MD5 |
c106fb0095c1d2ab27c9f02374f0f8bb
|
|
| BLAKE2b-256 |
32dbe129274936e9206e735c078bc38f4ccfa16b9a64ecacd39c0bd1dfd0253e
|
File details
Details for the file fairyfly_core-0.2.35-py3-none-any.whl.
File metadata
- Download URL: fairyfly_core-0.2.35-py3-none-any.whl
- Upload date:
- Size: 63.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ceffd2a0b61152d04e44c231ecac83be97e0a0fe9a7d35a414de51d64f89b05e
|
|
| MD5 |
093152c35cbc34f32325222695c40b69
|
|
| BLAKE2b-256 |
e018e2629c2a7af9574d21b820fd834420fe8f6367356a49afe58f23f5fa6516
|
