Skip to content

Commit

Permalink
Improve README (#17)
Browse files Browse the repository at this point in the history
* Add badges to README

* Include features, install and license
  • Loading branch information
drewyh authored May 24, 2020
1 parent 7b13273 commit a0e97a4
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 2 deletions.
54 changes: 53 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,56 @@
ambient
=======

ambient is a building physics python library.
|travis| |codecov| |readthedocs| |license| |black|

*ambient* is a building physics and simulation Python library.

The aims of *ambient* are to be:

#. Simple: Provide intuitive defaults to get started quickly.
#. Modular: Simulate only the parts you are interested in.
#. Extensible: Enable users to create and modify their own components.
#. Open: Provide an open-source building simulation library.

Features
--------

*ambient* currently offers modules for the analysis of:

- Layered constructions (including steady-state and dynamic response)
- Solar conditions (including design day calculations)
- Psychrometrics of moist air

Simulations can be read from, and written to, JSON format for persistence.

Installation
------------

Install *ambient* in a virtual environment using:

.. code-block:: python
pip install ambient
License
-------

*ambient* is licensed under the terms of the Apache License, Version 2.0.
Refer to the `LICENSE <https://github.com/drewyh/ambient/blob/master/LICENSE>`__
file for details.

.. |travis| image:: https://travis-ci.com/drewyh/ambient.svg?branch=master
:target: https://travis-ci.com/drewyh/ambient

.. |codecov| image:: https://codecov.io/gh/drewyh/ambient/branch/master/graph/badge.svg
:target: https://codecov.io/gh/drewyh/ambient

.. |readthedocs| image:: https://readthedocs.org/projects/ambient/badge/?version=latest
:target: https://ambient.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black

.. |license| image:: https://img.shields.io/pypi/l/ambient
:alt: PyPI - License
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description = A package for building engineering physics
long_description = file:README.rst
long_description_content_type = text/x-rst
keywords = building engineering physics, psychrometrics
license = Apache License, Version 2
license = Apache License 2.0
classifiers =
Topic :: Scientific/Engineering :: Physics
License :: OSI Approved :: Apache Software License
Expand Down

0 comments on commit a0e97a4

Please sign in to comment.