docs: update install docs

docs/README.md

@@ -56,3 +56,9 @@ See [mkdocs user guide](https://www.mkdocs.org/user-guide/deploying-your-docs/)
 ```bash
 mkdocs gh-deploy
 ```
+
+or optionally specify a remote repository:
+
+```bash
+mkdocs gh-deploy --remote <remote_name>
+```

docs/docs/install.md

@@ -2,31 +2,25 @@
 
 ## Local installation
 
-> Note: `flyvis` is only tested on Linux.
+Make sure to run `flyvis` in your active python environment.
 
-### Create virtual environment
-#### Option 1: Using conda (recommended)
+### Option 1: Install from PyPI
 
-1. Create a new conda environment: `conda create --name flyvision python=3.9 -y`
-2. Activate the new conda environment: `conda activate flyvision`
-
-#### Option 2: Using venv
+```bash
+pip install flyvis
+```
 
-1. Create a new virtual environment: `python -m venv flyvision_env`
-2. Activate the virtual environment: `source flyvision_env/bin/activate`
+> `flyvis` is tested on Linux for python 3.9, 3.10, 3.11, 3.12.
 
-### Clone repo and install
+### Option 2: Install from source
 
-3. Clone the repository: `git clone https://github.com/TuragaLab/flyvis.git`
-4. Navigate to the repo: `cd flyvis`
-5. Install in developer mode: `pip install -e .`
+1. Clone the repository: `git clone https://github.com/TuragaLab/flyvis.git`
+2. Navigate to the repo: `cd flyvis`
+3. Install in developer mode: `pip install -e .`
 
 For development, documentation, or to run examples, you can install additional dependencies:
-- For development: `pip install -e ".[dev]"`
-- For documentation: `pip install -e ".[docs]"`
-- For examples: `pip install -e ".[example]"`
+- `pip install -e ".[dev,examples,docs]"`
 
-> Note: We make flyvision available on pypi soon to simplify the installation process.
 
 ## Download pretrained models
 
@@ -36,9 +30,6 @@ After installation, download the pretrained models by running:
 flyvis download-pretrained
 ```
 
-Make sure to run this command from your active flyvision environment.
-
-
 ## Set environment variables
 
 `flyvis` uses environment variables for configuration. These can be set using a `.env` file or manually.
@@ -66,3 +57,13 @@ export FLYVIS_ROOT_DIR='path/to/your/data'
 ```
 
 > Note: The data directory is where `flyvis` will store downloaded models, cached data, and other files. If `FLYVIS_ROOT_DIR` is not set, it defaults to a `data` folder in the package directory.
+
+## Training new models
+
+For training new models with custom settings, the following command will create a default config in your current working directory to be able to create overrides.
+
+```bash
+flyvis init-config
+```
+
+See the config [hydra config docs](reference/hydra_default_config.md) for more details.

docs/docs/release.md

@@ -123,21 +123,11 @@ git push public_repo v1.1.2
 # Clean previous builds
 rm -rf dist/
 
-# Build package
-python -m build
-
 # Set version temporarily for this session manually
 export SETUPTOOLS_SCM_PRETEND_VERSION=1.1.2
 
-# Now build and test
+# Build package
 python -m build
-python -m twine upload --repository testpypi dist/*
-
-# When done testing, unset it
-unset SETUPTOOLS_SCM_PRETEND_VERSION
-
-# Upload to Test PyPI first (recommended)
-python -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ flyvis==1.1.2
 
 # Upload to PyPI
 python -m twine upload dist/*