sunmine

Sunmine is a piece of python software (xmrig, xmr-stak etc) that aims to switch on your mining software during the most profitable SOLAR times.

It uses APIs that check if the sun has risen and the weather conditions in your specified location.

---

Table of Contents

1. Getting Started
   a. Prerequisites
   b. Installing
   c. Editing the config file
   d. Running
   e. Setting up as a scheduled task
   
2. Built With
3. Authors
4. The OpenWeatherMap API
5. Licence

Getting Started

Prerequisites

Your computer runs the following software:

• Python 3.7+ download
• pip package installer download

Installing

• git clone https://github.com/howbotnik/sunmine.git
• cd sunmine
• pip install -r requirements.txt

Editing the config file (Essential)

• Open sunmine.cfg
• Read CONFIG_README.md for help setting up

Running

• cd sunmine
• python main.py
  
  

Set up as a scheduled task:

Use crontab or Windows 'Task Scheduler' if you want the program to run automatically.

---

Built with

Python & PyCharm Community
Weather by https://Openweathermap.org
Sun data by https://api.sunrise-sunset.org

---

Authors

H. Wilson

---

Open Weather API

The OpenWeatherMap API allows customization using the weather codes on this website:

• https://openweathermap.org/weather-conditions

As a default, sunmine is set up to use the following weather codes as acceptable for mining, but this may depend on your setup:

• 800 - Clear Sky
• 801 - Few Clouds (11-25%)
• 802 - Scattered Clouds (25-50%)

Edit the acceptable weather codes in the config file for customization.

---

Licence

MIT License

Copyright (c) 2020 Howard Wilson