Installing#
There are different ways to install the package depending on what you intend to do. The package is available on the Python Package Index. If you mainly intend to use the package as is, the easiest is to install from there.
If you are brand new to Python, we recommend uv as a python installer. They have excellent guides on how to get started.
When you have a project started, simply add uwacan as a dependency with uv add uwacan.
The rest of this page concerns more advanced installation methods.
Installing an editor
You will need a code editor to work with python.
The most widely used editor is Visual Studio Code. It has good editing features, strong python language support, and a very nice terminal emulator. If you do not intend to use it for writing lots of code, it can be a bit feature-heavy. If you go this route, you will not need any other tools.
The Spyder IDE offers a Matlab-esque environment. It is somewhat opinionated with regards to python environments, so it can be difficult to get it working reliably.
The Jupyter project allows you to write python code and notebooks in the browser. The JupyterLab version (instead of jupyter notebook) includes editing of scripts, linked python consoles, and a terminal. This creates a good development environment for basic usage. You will however need some text editing tool and a terminal to get started.
Installing the package for development#
We have chosen to use uv as our python installer and package tooling.
Clone the git repo
Install the environment with uv
Including the package as a submodule#
Initialize the top repo (git clone or git init)
git init uv init
Add the uwacan repo as a submodule
git submodule add git+https://github.com/CarlAndersson/underwater-acoustic-analysis uwacan git submodule init
Add the local submodule as an editable dependency
uv add "uwacan @ underwater-acoustics-analysis" --editable
Add some development dependencies for your local code. You can use e.g.,
uv add jupyterto add packages.