A standalone client for the NREL Alfalfa application
Project description
Alfalfa Client
The purpose of this repository is to provide a standalone client for use with the Alfalfa application. It additionally includes a Historian to quickly/easily enable saving of results from Alfalfa simulations.
Usage
This repo is packaged and hosted on PyPI here.
pip install alfalfa-client
from alfalfa_client.alfalfa_client import AlfalfaClient
client = AlfalfaClient("http://localhost")
Additional documentation for the functions of alfalfa-client
can be found here.
Development
Prerequisites:
- poetry for managing environment
Cloning and Installing:
git clone https://github.com/NREL/alfalfa-client.git
cd alfalfa-client
poetry install
Running Tests:
All alfalfa-client
tests currently require a running instance of Alfalfa with at least 2 workers.
poetry run pytest -m integration
Releasing
- Finish merging PRs into develop
- Confirm all tests pass
- Update the version (assume version is 0.1.2):
poetry version 0.1.2
- Create PR to merge version update
- Rebase develop onto main, make sure tests pass
- Create a tag:
git tag 0.1.2
- Build:
poetry build
- Publish
poetry publish
(this will push to pypi) - Create a new release on the Github repository using the tag and link to PyPI
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
alfalfa_client-0.7.0.tar.gz
(7.0 kB
view hashes)
Built Distribution
Close
Hashes for alfalfa_client-0.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47719e75b864c38a8de2c49ffa45abe55df0d4fdcbce2bdea1cde30b3bb81e8f |
|
MD5 | 2cec41ad00dc4794515c112ddd4e4f85 |
|
BLAKE2b-256 | 17e335b6facccd2a759011610015b56e33b9f811565840d76fb5cdb0848c7a9e |