Skip to content
forked from jlillywh/Aegis

This is a water resources library in its very early stages. (stay tuned)

License

Notifications You must be signed in to change notification settings

tanxuezhi/Aegis

 
 

Repository files navigation

Aegis

alt text

This is a library for simulating water resources systems. Components in this library (if used by themselves) operate at a single point in time. Objects used in the simulator will update using the clock and produce time series results to show how the state of the system changes over time.

The modules currently available:

Australian Water Balance Model

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

  • Maven - Dependency Management
  • ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc

About

This is a water resources library in its very early stages. (stay tuned)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 91.3%
  • HTML 6.6%
  • Jupyter Notebook 2.1%