Tutorials will be ready after the package is released

Tutorials for Polony Counter

Welcome to the tutorials section! These guides will help you get started with the Polony Counter project. We assume that you have a basic understanding of Python and working with command-line interfaces. We currently support installation via Poetry, with pip installation coming in a future version.

Setting Up Your Environment

Objective: Learn how to set up the Polony Counter environment using the current method (Poetry) and understand the future pip installation method.

Using Poetry (Current Method)

1. Clone the Repository:
2. Use git clone https://github.com/kirill-push/polony-counting.git to clone the repository to your local machine.
3. Install Poetry:
4. If you don't have Poetry installed, follow the instructions on the Poetry website to install it.
5. Install Dependencies with Poetry:
6. Navigate to the cloned repository's root directory.
7. Run poetry install to set up the project and install all necessary dependencies.

Using pip (Future Method)

In a future version, you will be able to install Polony Counter directly using pip. This section will be updated with instructions once this feature is available.

Running Your First Analysis

Objective: Understand how to prepare your data and run the initial analysis.

1. Data Preparation:
2. Guide on how to format your input data for analysis.
3. Instructions on using make_dataset.py script to prepare your data.
4. Running the Analysis:
5. Detailed steps on how to use the predict_model.py script.
6. Information on interpreting the output of the script.

Advanced Usage

Objective: Dive deeper into advanced features and custom configurations.

1. Customizing Configurations:
2. Explanation of the configuration files in the config directory.
3. Steps to modify these configurations for custom use cases.
4. Using Custom Models:
5. Guide on integrating custom models into the pipeline.
6. Instructions for training new models using train_model.py.