diff --git a/README.rst b/README.rst index 81ed67222ba3b5f27199d2c6d8c184e243686a10..94d1b822188fe77df3ba69cde967d4626f9163ac 100644 --- a/README.rst +++ b/README.rst @@ -1,11 +1,31 @@ -FFME: A generic framework to solve arbitrary set of moment equations arise in the context of moment methods in kinetic gas theory -================================================================================================================================= +About +==== +A generic solver to solve moment models arise in kinetics gas theory. +Thanks to FEniCS, this solver is one-to-one in correspondence with +mathematical formulation. +It is being developed as a part of PhD project F2ME. As the project +is currently undergoing code restructuring I have not made the +documention of the code publically available (yet!). I plan to publish +it very soon. I am always interested in sharing information if you are trying +to use this solver. Drop me an email. + +Quick Usage +============= +To make things simpler, I created a docker image which is in turn built +upon the FEniCS docker image. To get started, follow the instruction below: +Make sure you have docker and docker-compose installed. + +```bash +$ git clone git@gitlab.com/19ec94/f2me.git +$ cd f2me +$ docker-compose run --rm fenics_rx_local +$ cd f2me/f2me +$ python3 f2me.py input_example.yml +``` -Main features -------------------------------------------------------------------------------- +## Contact --blabla --blabla blabla - -Installation -------------- +| Name | Email | +| ------ | ----------- | +| Edilbert Christhuraj | [christhuraj@acom.rwth-aachen.de](christhuraj@acom.rwth-aachen.de) | +| Prof. Manuel Torrilhon | [mt@acom.rwth-aachen.de](mt@acom.rwth-aachen.de)|