Skip to content

more readme cleanup #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.