Skip to content

Update index.md #6

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.

Sign up for GitHub

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
LOCEANlloydizard merged 1 commit into from
Jan 12, 2026
Merged

Update index.md #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Tutorials and example workflows are provided as Jupyter notebooks and are
documented separately in the
[**LAMTA Examples documentation**](https://lamta-examples.readthedocs.io/).

These examples are designed to run against a local installation of LAMTA and are not a standalone package.s
To run the tutorials make sure that:

- LAMTA is installed in the same Python environment (preferably in editable mode)
Expand Down Expand Up @@ -80,8 +81,18 @@ We recommend using Visual Studio Code and opening the parent folder (e.g. `lamta

### Step 1 — Clone the repository

```{warning}
If you only want to run the notebooks, cloning the repository is sufficient.
If you plan to contribute to the code or documentation, we recommend forking the repository first and cloning your fork instead.
```

```bash
git clone https://github.com/OceanCruises/LAMTA.git
# Users
git clone https://github.com/OceanCruises/LAMTA_examples

# Contributors
# git clone https://github.com/<your-username>/LAMTA_examples

cd LAMTA
```

Expand Down