https://github.com/pdebuyl/pympcd

pyMPCD - hydrodynamical simulations with MPCD
https://github.com/pdebuyl/pympcd

Last synced: 28 days ago
JSON representation

pyMPCD - hydrodynamical simulations with MPCD

• Host: GitHub
• URL: https://github.com/pdebuyl/pympcd
• Owner: pdebuyl
• License: gpl-3.0
• Created: 2013-07-24T12:11:23.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-07-16T13:29:19.000Z (over 9 years ago)
• Last Synced: 2023-04-05T02:28:17.075Z (over 1 year ago)
• Language: Python
• Size: 181 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.txt
  • License: LICENSE

Awesome Lists containing this project

README

        
=============================================

pyMPCD - hydrodynamical simulations with MPCD

=============================================

Copyright (c) 2011 Pierre de Buyl 

pyMPCD is a package to perform hydrodynamical simulation with the particle-based

MPCD algorithm. pyMPCD requires the NumPy library

pyMPCD is developed by Pierre de Buyl and is available under the `GNU General

Public License `_. The GNU General Public

License is found in the file LICENSE. The homepage for pyMPCD is

``_.

Requirements

============

* `Python `_.

* The `NumPy `_ library.

* A Fortran 90 compiler that is enabled by `F2py `_.

Installation

============

From the pyMPCD archive, type ::

    python setup.py install

at a command prompt, with an optional ``--prefix`` argument specifying the

location of installation.

Usage

=====

A simple example of script is found the the ``examples`` directory. After proper

installation it is run by typing ::

    python simple_example.py

at a command prompt.

Documentation

=============

The documentation is provided at pyMPCD's `homepage

`_ where one can find a full

doxygen-generated API documentation. The documentation can also be generated by

executing `doxygen `_ in the

``doc`` directory, with the ``doxy_conf`` argument.

Appropriate citation is appreciated in any scientific publication that makes use

of this software. The latest citation suggestion is ::

    P. de Buyl, "pyMPCD - hydrodynamical simulations with MPCD"

    http://homepages.ulb.ac.be/~pdebuyl/pyMPCD/.