Metadata-Version: 2.4
Name: simulatr
Version: 0.0.1
Summary: Gym environment for reinforcement learning using ApsimX
Author-email: Meagan Lang <langmm.astro@gmail.com>
Maintainer-email: Meagan Lang <langmm.astro@gmail.com>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/langmm/ApsimX
Project-URL: Documentation, https://github.com/langmm/ApsimX
Project-URL: Repository, https://github.com/langmm/ApsimX
Project-URL: Issues, https://github.com/langmm/ApsimX/issues
Project-URL: Changelog, https://github.com/langmm/ApsimX/blob/main/ApsimXGym/HISTORY.rst
Keywords: apsim,apsimx,simulatr,reinforcement leanring,machine learning
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: gymnasium
Requires-Dist: msgpack
Requires-Dist: numpy>=1.13.0
Requires-Dist: pandas
Requires-Dist: pydantic
Requires-Dist: pyzmq
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: myst-parser; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: tox; extra == "dev"
Dynamic: license-file

Simulatr provides a [gymnasium](https://gymnasium.farama.org/) environment for reinforcement learning using different simulators including:

- [ApsimX](https://docs.apsim.info/)

# Installation

Simulatr can be installed via pip or pixi can be utilized

```
pip install -e .
```

In addition to installing the gym, you will also need to install the simulators you wish to run.

# Simulator installation

Simulatr will install the required simulators automatically, but you can also install the simulators yourself via the simulatr CLI before running a simulator

```
python -m simulatr install apsimx
```

# Running a simulator

## Running to completion

```
python -m simulatr run apsimx --crop-name wheat --from-example
```

## Running interactively

```
python -m simulatr run apsimx --crop-name wheat --from-example --timestep=10  # days
```

Additional documentation can be found [here](https://langmm.github.io/simulatr/),

=======
History
=======

0.0.1 (????-??-??)
------------------

* Initial release.
