Coder Social home page Coder Social logo

poresim's Introduction


PyPI Version License: GPL v3 DOI Build Status codecov

Documentation

Online documentation is available at ajax23.github.io/PoreSim.

The docs include an example for creating simulation boxes, and an API reference.

Dependencies

PoreSim supports Python 3.5+.

Installation requires pyyaml and jinja2.

Installation

You may instead want to use the development version from GitHub:

pip install git+https://github.com/ajax23/PoreSim.git#egg=poresim

pip install git+https://github.com/ajax23/PoreSim.git@develop#egg=poresim

Or download the repository and install in the top directory via:

pip install .

Testing

To test PoreSim, run the test in the test directory.

Development

PoreSim development takes place on Github: www.github.com/Ajax23/PoreSim

Please submit any reproducible bugs you encounter to the issue tracker.

How to Cite PoreSim

When citing PoreSim please use the current Zenodo DOI corresponding to the used PoreSim version. (Current DOI is listed in the badges.)

poresim's People

Contributors

ajax23 avatar marc310896 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.