Welcome to ATMOS Analogue Digital Twin (ADAM)’s documentation!#
User Guide
The cookbook provides in-depth information on how to use ADAM, including how to get started. This is where to look for general conceptual descriptions on how to use parts of ADAM, including how to make your first lake breeze front and the required data preprocessing to do so.
Reference Guide
The reference guide contains detailed descriptions on every function and class within ADAM. This is where to turn to understand how to use a particular feature or where to search for a specific tool
Developer Guide
Want to help make ADAM better? Found something that’s not working quite right? You can find instructions on how to contribute to ADAM here. You can also find detailed descriptions on tools useful for developing ADAM.
Example Gallery
Check out ADAM’s gallery of examples which contains sample code demonstrating various parts of ADAM’s functionality.
Getting started#
ADAM is published on PyPI as adam-atmos:
$ pip install adam-atmos
See Installation for installing from source and for the full list of requirements.