Volatenium

A simple algorithm-based python crypto trader

Installation

1. Download the repo with either:
   • git:
     1. git clone https://github.com/Aegeontis/Volatenium.git
     2. cd Volatenium
   • as zip:
     1. Download https://github.com/Aegeontis/Volatenium/archive/refs/heads/main.zip
     2. unzip Volatenium-main.zip
     3. cd Volatenium-main
2. Initiate a python venv: python -m venv venv
3. Enter the python venv: source venv/bin/activate
4. Install requirements: pip install -r requirements.txt
5. Create a settings.yaml file. MAKE SURE each algorithm has a UNIQUE id. Example below:

general_settings:
  action_interval: 60.0
exchanges:
  Simulator:
    exchange_settings:
    algorithms:
      - id: 0
        codename: "SafeTrade"
        algorithm_vars:
          wallet_crypto_amount: 0.0
          wallet_fiat_amount: 100.0
        exchange_vars:
          crypto_codename: "BTC-EUR"
          exchange_fee: 0.0001
          wallet_crypto_amount: 0.0
          wallet_fiat_amount: 100.0
      - id: 1
        codename: "SafeTrade"
        algorithm_vars:
          wallet_crypto_amount: 0.0
          wallet_fiat_amount: 100.0
        exchange_vars:
          crypto_codename: "ETH-EUR"
          exchange_fee: 0.0001
          wallet_crypto_amount: 0.0
          wallet_fiat_amount: 100.0

Usage

Normal usage

1. Enter the python venv: source venv/bin/activate
2. Start the script: python main.py

Generate graph

1. Enter the python venv: source venv/bin/activate
2. Start the script: python main.py --generate-graph