Metadata-Version: 2.1
Name: gridworks-atn
Version: 0.0.1
Summary: Gridworks Atn Spaceheat
Home-page: https://github.com/thegridelectric/gridworks-atn
License: None
Author: Jessica Millar
Author-email: jmillar@gridworks-consulting.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: boto3 (>=1.26.3,<2.0.0)
Requires-Dist: gridworks (>=0.0.5,<0.0.6)
Requires-Dist: gridworks-protocol (>=0.1.5,<0.2.0)
Requires-Dist: numpy (>=1.23.4,<2.0.0)
Requires-Dist: paho-mqtt (>=1.6.1,<2.0.0)
Requires-Dist: types-requests (>=2.28.11.2,<3.0.0.0)
Project-URL: Changelog, https://github.com/thegridelectric/gridworks-atn/releases
Project-URL: Documentation, https://gridworks-atn.readthedocs.io
Project-URL: Repository, https://github.com/thegridelectric/gridworks-atn
Description-Content-Type: text/markdown

# Gridworks Atn Spaceheat

[![PyPI](https://img.shields.io/pypi/v/gridworks-atn.svg)][pypi_]
[![Status](https://img.shields.io/pypi/status/gridworks-atn.svg)][status]
[![Python Version](https://img.shields.io/pypi/pyversions/gridworks-atn)][python version]
[![License](https://img.shields.io/pypi/l/gridworks-atn)][license]

[![Read the documentation at https://gridworks-atn.readthedocs.io/](https://img.shields.io/readthedocs/gridworks/latest.svg?label=Read%20the%20Docs)][read the docs]
[![Tests](https://github.com/thegridelectric/gridworks-atn/workflows/Tests/badge.svg)][tests]
[![Codecov](https://codecov.io/gh/thegridelectric/gridworks-atn/branch/main/graph/badge.svg)][codecov]

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]

[pypi_]: https://pypi.org/project/gridworks-atn/
[status]: https://pypi.org/project/gridworks-atn/
[python version]: https://pypi.org/project/gridworks-atn
[read the docs]: https://gridworks-atn.readthedocs.io/
[tests]: https://github.com/thegridelectric/gridworks-atn/actions?workflow=Tests
[codecov]: https://app.codecov.io/gh/thegridelectric/gridworks-atn
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black

Repo for AtomicTNodes

## Local Demo Setup

1. Set up python envirnment

   ```
   poetry install

   poetry shell
   ```

2. Install [docker](https://docs.docker.com/get-docker/)

3. Start docker containers

- **X86 CPU**:

  ```
  docker compose -f world-rabbit-x86.yml up -d
  ```

- **arm CPU**:

  ```
  docker compose -f world-rabbit-arm.yml up -d
  ```

4. Check rabbit on its console at [http://0.0.0.0:15672/#/](http://0.0.0.0:15672/#/)

   - username/password are both

     ```
     smqPublic
     ```

5. Run demo:

   ```
   python demo.py
   ```

## Usage

Please see the [Command-line Reference] for details.

## Contributing

Contributions are very welcome.
To learn more, see the [Contributor Guide].

## License

Distributed under the terms of the [MIT license][license],
_Gridworks Atn Spaceheat_ is free and open source software.

## Issues

If you encounter any problems,
please [file an issue] along with a detailed description.

## Credits

This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.

[@cjolowicz]: https://github.com/cjolowicz
[pypi]: https://pypi.org/
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
[file an issue]: https://github.com/thegridelectric/gridworks-atn/issues
[pip]: https://pip.pypa.io/

<!-- github-only -->

[license]: https://github.com/thegridelectric/gridworks-atn/blob/main/LICENSE
[contributor guide]: https://github.com/thegridelectric/gridworks-atn/blob/main/CONTRIBUTING.md
[command-line reference]: https://gridworks-atn.readthedocs.io/en/latest/usage.html

