Seaweed Algebra

A Python library for computing, plotting, and other tasks related to seaweed algebra.

Setup

Requirements

• Python
• pip (typically installed alongside python)

Development Environments

Any Python or Jupyter Notebook development environment will work!

Here are a few recommendations if you need a place to start:

• Visual Studio Code (very popular)
  • Install the Python Extension.
  • If you want to use notebooks, you'll want the Jupyter Extension as well.
• Google Colab (cloud based)
  • Try opening this demo file in Colab.
• JupyterLab / Jupyter Notebook

Installation

Running the following command will tell pip to download the most recently published version from the Python Package Index.

pip install seaweed-algebra

Advanced installation information

If you wish to use a version of the library that is unpublished, you can do so in a few ways:

Installing from GitHub

pip install git+https://github.com/daflamingfox/seaweed_algebra

Additionally, you can specify a specific version by appending @VERSION to the link, where @VERSION can be:

• A specific branch, such as @main (the default if no @VERSION is provided)
• A specific tag, such as @v0.0.5
• A specific commit hash, such as @c87aad3

Installing from a local copy

If you want to change the source code yourself and test your changes, you can install your local copy of the library like such:

# This command assumes you are running it from the base project directory.
pip install -e .

Using the -e flag tells pip to install the package as 'editable,' so that any changes you make to the source code is immediately reflected in the installed version on your machine.

Usage

See the example folder for examples and demos for how to use the library.

License

This work is licensed under the GNU Lesser General Public License.