tesa-os-only-pipeline

Repo of OS-only GIS tools for tesa processing (aka 'the pipeline'). Below is how to setup the conda environment used for (most) of these tools (some of the deep learning stuff - like 'are-you-square' is the exception - which will have its own conda instructions in the README).

Table of Contents

• Installation
  • Prerequisites
  • Using requirements.txt
  • Using environment.yml
• Usage
• License

Installation

Follow these steps to set up the project on your local machine.

Prerequisites

• Conda should be installed on your system.
• Install Microsoft C++ Build Tools (maybe)

Using environment.yml

1. Clone the Repository

   git clone https://github.com/American-Forests/tesa-os-only-pipeline.git
   cd tesa-os-only-pipeline

2. Create the Conda Environment

   Create a new Conda environment from the environment.yml file:

   conda env create -f environment.yml

3. Activate the Conda Environment

   Activate the environment you just created:

   conda activate OS-only-GIS

4. Verify the Installation

   Ensure all the packages are installed correctly by listing the installed packages:

   conda list

Updating the Environment

If you make changes to the environment.yml file and need to update the environment, you can use the following command:

conda env update --file environment.yml --prune

The --prune flag removes dependencies that are no longer required.

Deactivating and Removing the Environment

To deactivate the current environment, use:

conda deactivate

To remove the environment completely, use:

conda env remove -n OS-only-GIS

Usage

For any of the scripts in this repo, please provide instructions and examples for using your project. Here’s an example:

python script.py

License

This project is licensed under the MIT License.