an-augment

Setup Guide for ANAugment

Welcome to the setup guide for ANAugment (Advanced and Novel Augmentation). Follow the steps below to get started.

Prerequisites

Before you begin, ensure you have the following installed:

• Git
• Python (version 3.6 or higher)
• pip

Installation Steps

1. Clone the repository:

    git clone https://github.com/lunovian/an-augment.git
   

2. Navigate to the project directory:

    cd an_augment
   

3. Create a virtual environment:

    python -m venv venv
   

4. Activate the virtual environment:

   • On Windows:

       venv\Scripts\activate
     

   • On macOS/Linux:

       source venv/bin/activate
     

5. Install dependencies:

    pip install -r requirements.txt
   

Running the Project

To start the project, run:

python main.py

Building the Project

To create a distribution package, run:

python setup.py sdist bdist_wheel

Testing

To run tests, use:

pytest

For further assistance, please refer to the CONTRIBUTING.md file or open an issue on GitHub.

Happy coding!

This site is open source. Improve this page.