Skip to content

Commit

Permalink
Merge pull request #243 from StochSS/develop
Browse files Browse the repository at this point in the history
v1.0.1
  • Loading branch information
BryanRumsey committed Mar 11, 2022
2 parents ac5051d + 329ee2d commit 990a99b
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 22 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<p align="left">
<img src="https://raw.githubusercontent.com/StochSS/SpatialPy/main/logo/SpatialPy_logo.png">
<img src="https://raw.githubusercontent.com/StochSS/SpatialPy/main/.graphics/SpatialPy_logo.png">
</p>

SpatialPy is a Python 3 package for simulation of spatial deterministic/stochastic reaction-diffusion-advection problems embedded in Lagrangian reference frame particle based fluid dynamics domain

This package is intended to replace the PyURDME software https://github.com/pyurdme/pyurdme and will feature both a NSM solver for RDME simulation on static domains and a sSSA-SDPD particle based fluid dynamics solver as described in the publication "A hybrid smoothed dissipative particle dynamics (SDPD) spatial stochastic simulation algorithm (sSSA) for advection–diffusion–reaction problems" by Drawert, Jacob, Li, Yi, Petzold https://www.sciencedirect.com/science/article/pii/S0021999118307101

<table><tr><td><b>
<img width="20%" align="right" src="https://raw.githubusercontent.com/SpatialPy/SpatialPy/develop/.graphics/stochss-logo.png">
<img width="20%" align="right" src="https://raw.githubusercontent.com/SpatialPy/SpatialPy/main/.graphics/stochss-logo.png">
<a href="https://docs.google.com/forms/d/12tAH4f8CJ-3F-lK44Q9uQHFio_mGoK0oY829q5lD7i4/viewform">PLEASE REGISTER AS A USER</a>, so that we can prove SpatialPy has many users when we seek funding to support development. SpatialPy is part of the <a href="http://www.stochss.org">StochSS</a> project.
</td></tr></table>

Expand All @@ -25,9 +25,11 @@ Table of contents
- [_Using the source code repository_](#using-the-source-code-repository)
- [Usage](#usage)
- [_Simple example to illustrate the use of SpatialPy_](#simple-example-to-illustrate-the-use-of-spatialpy)
<!--
- [_Docker environment_](#docker-environment)
- [_Debugging_](#debugging)
- [_Profiling_](#profiling)
-->
- [Getting help](#getting-help)
- [Contributing](#contributing)
- [License](#license)
Expand Down Expand Up @@ -72,8 +74,8 @@ SpatialPy provides simple object-oriented abstractions for defining a model of a

The `run()` method can be customized using keyword arguments to select different solvers, random seed, data return type and more. For more detailed examples on how to use SpatialPy, please see the Jupyter notebooks contained in the [examples](https://github.com/StochSS/SpatialPy/tree/main/examples) subdirectory.


### Docker environment
<!--
### Docker environment (DOES NOT WORK)
You can use Docker to create a repeatable environment for developing and debugging SpatialPy. The supplied Dockerfile starts a jupyter server with SpatialPy dependencies installed.
Expand Down Expand Up @@ -102,6 +104,7 @@ You can invoke `solver.run_debugger()` anytime after you instantiate a solver in
### Profiling
To enable profiling, both `solver.compile()` and `solver.run()` need to be invoked with `profile=True`. If you don't run `solver.compile()` explicitly, invoking `solver.run()` with `profile=True` will run `compile()` correctly for you.
-->

Getting help
------------
Expand Down
17 changes: 0 additions & 17 deletions RELEASE_NOTES

This file was deleted.

2 changes: 1 addition & 1 deletion spatialpy/__version__.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
# @website https://github.com/StochSS/SpatialPy
# =============================================================================

__version__ = '1.0'
__version__ = '1.0.1'
__title__ = 'SpatialPy'
__description__ = 'Python Interface for Spatial Stochastic Biochemical Simulations'
__url__ = 'https://spatialpy.github.io/SpatialPy/'
Expand Down

0 comments on commit 990a99b

Please sign in to comment.