diff --git a/.github/SETUP_COVERAGE_BADGE.md b/.github/SETUP_COVERAGE_BADGE.md index c8d9e70..e50363a 100644 --- a/.github/SETUP_COVERAGE_BADGE.md +++ b/.github/SETUP_COVERAGE_BADGE.md @@ -30,7 +30,7 @@ For **private repositories**: If your repository is private: 1. **Get Your Codecov Token** - - Navigate to https://codecov.io/gh/devskill-org/energy-management-system + - Navigate to https://codecov.io/gh/devskill-org/ems - Click on "Settings" in the left sidebar - Copy the "Repository Upload Token" @@ -46,7 +46,7 @@ If your repository is private: 1. **Commit and push** your changes (if you haven't already) 2. **Wait for workflow** to complete (check the Actions tab) -3. **Visit Codecov** dashboard at https://codecov.io/gh/devskill-org/energy-management-system +3. **Visit Codecov** dashboard at https://codecov.io/gh/devskill-org/ems 4. **Check your README** - the badge should now display the coverage percentage ## Badge Configuration @@ -54,13 +54,13 @@ If your repository is private: The coverage badge is already configured in your README.md: ```markdown -[![Coverage](https://codecov.io/gh/devskill-org/energy-management-system/branch/main/graph/badge.svg)](https://codecov.io/gh/devskill-org/energy-management-system) +[![Coverage](https://codecov.io/gh/devskill-org/ems/branch/main/graph/badge.svg)](https://codecov.io/gh/devskill-org/ems) ``` If you use a different default branch (e.g., `master`), update the badge URL: ```markdown -[![Coverage](https://codecov.io/gh/devskill-org/energy-management-system/branch/master/graph/badge.svg)](https://codecov.io/gh/devskill-org/energy-management-system) +[![Coverage](https://codecov.io/gh/devskill-org/ems/branch/master/graph/badge.svg)](https://codecov.io/gh/devskill-org/ems) ``` ## Codecov Features @@ -95,17 +95,17 @@ You can customize your badge appearance: ### Default Badge ```markdown -[![Coverage](https://codecov.io/gh/devskill-org/energy-management-system/branch/main/graph/badge.svg)](https://codecov.io/gh/devskill-org/energy-management-system) +[![Coverage](https://codecov.io/gh/devskill-org/ems/branch/main/graph/badge.svg)](https://codecov.io/gh/devskill-org/ems) ``` ### Flat Style Badge ```markdown -[![Coverage](https://codecov.io/gh/devskill-org/energy-management-system/branch/main/graph/badge.svg?style=flat)](https://codecov.io/gh/devskill-org/energy-management-system) +[![Coverage](https://codecov.io/gh/devskill-org/ems/branch/main/graph/badge.svg?style=flat)](https://codecov.io/gh/devskill-org/ems) ``` ### Flat-Square Style Badge ```markdown -[![Coverage](https://codecov.io/gh/devskill-org/energy-management-system/branch/main/graph/badge.svg?style=flat-square)](https://codecov.io/gh/devskill-org/energy-management-system) +[![Coverage](https://codecov.io/gh/devskill-org/ems/branch/main/graph/badge.svg?style=flat-square)](https://codecov.io/gh/devskill-org/ems) ``` ## Troubleshooting diff --git a/.github/workflows/README.md b/.github/workflows/README.md index c81040d..1355ddc 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -55,13 +55,13 @@ To get coverage badges and detailed reports at [Codecov](https://codecov.io): - Value: Your Codecov token 4. **View Coverage Reports** - - After the first workflow run, visit https://codecov.io/gh/devskill-org/energy-management-system + - After the first workflow run, visit https://codecov.io/gh/devskill-org/ems - View detailed coverage reports, trends, and file-by-file analysis - The badge in README.md will automatically update **Badge:** ```markdown -[![Coverage](https://codecov.io/gh/devskill-org/energy-management-system/branch/main/graph/badge.svg)](https://codecov.io/gh/devskill-org/energy-management-system) +[![Coverage](https://codecov.io/gh/devskill-org/ems/branch/main/graph/badge.svg)](https://codecov.io/gh/devskill-org/ems) ``` ### Alternative: Simple Test Status Badge @@ -69,13 +69,13 @@ To get coverage badges and detailed reports at [Codecov](https://codecov.io): If you don't want to use Codecov, you can use just the test status badge: ```markdown -[![Tests](https://github.com/devskill-org/energy-management-system/actions/workflows/test.yml/badge.svg)](https://github.com/devskill-org/energy-management-system/actions/workflows/test.yml) +[![Tests](https://github.com/devskill-org/ems/actions/workflows/test.yml/badge.svg)](https://github.com/devskill-org/ems/actions/workflows/test.yml) ``` ## Viewing Coverage Reports ### In Codecov -1. Visit https://codecov.io/gh/devskill-org/energy-management-system +1. Visit https://codecov.io/gh/devskill-org/ems 2. View coverage percentage, trends, and file-by-file breakdown 3. See coverage changes in pull requests @@ -110,9 +110,9 @@ Then open `coverage.html` in your browser. Add these badges to your README.md: ```markdown -[![Tests](https://github.com/devskill-org/energy-management-system/actions/workflows/test.yml/badge.svg)](https://github.com/devskill-org/energy-management-system/actions/workflows/test.yml) -[![Coverage](https://codecov.io/gh/devskill-org/energy-management-system/branch/main/graph/badge.svg)](https://codecov.io/gh/devskill-org/energy-management-system) -[![Go Report Card](https://goreportcard.com/badge/github.com/devskill-org/energy-management-system)](https://goreportcard.com/report/github.com/devskill-org/energy-management-system) +[![Tests](https://github.com/devskill-org/ems/actions/workflows/test.yml/badge.svg)](https://github.com/devskill-org/ems/actions/workflows/test.yml) +[![Coverage](https://codecov.io/gh/devskill-org/ems/branch/main/graph/badge.svg)](https://codecov.io/gh/devskill-org/ems) +[![Go Report Card](https://goreportcard.com/badge/github.com/devskill-org/ems)](https://goreportcard.com/report/github.com/devskill-org/ems) ``` ## Troubleshooting @@ -138,4 +138,4 @@ Add these badges to your README.md: - [GitHub Actions Documentation](https://docs.github.com/en/actions) - [Go Testing Documentation](https://golang.org/pkg/testing/) - [Codecov Documentation](https://docs.codecov.com/) -- [golangci-lint Documentation](https://golangci-lint.run/) \ No newline at end of file +- [golangci-lint Documentation](https://golangci-lint.run/) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d3cf91..eb5f6fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ Thank you for your interest in contributing to the Energy Management System! Thi ``` 3. Add the upstream repository: ```bash - git remote add upstream https://github.com/devskill-org/energy-management-system.git + git remote add upstream https://github.com/devskill-org/ems.git ``` ## Development Setup @@ -355,4 +355,4 @@ Closes #123 By contributing, you agree that your contributions will be licensed under the same license as the project. -Thank you for contributing! 🎉 \ No newline at end of file +Thank you for contributing! 🎉 diff --git a/README.md b/README.md index 859d559..cabc97c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Energy Management System (EMS) -[![Tests](https://github.com/devskill-org/energy-management-system/actions/workflows/test.yml/badge.svg)](https://github.com/devskill-org/energy-management-system/actions/workflows/test.yml) -[![Coverage](https://codecov.io/gh/devskill-org/energy-management-system/branch/main/graph/badge.svg)](https://codecov.io/gh/devskill-org/energy-management-system) -[![Go Report Card](https://goreportcard.com/badge/github.com/devskill-org/energy-management-system)](https://goreportcard.com/report/github.com/devskill-org/energy-management-system) -[![Go Version](https://img.shields.io/github/go-mod/go-version/devskill-org/energy-management-system)](https://github.com/devskill-org/energy-management-system/blob/main/go.mod) -[![License](https://img.shields.io/github/license/devskill-org/energy-management-system)](https://github.com/devskill-org/energy-management-system/blob/main/LICENSE) +[![Tests](https://github.com/devskill-org/ems/actions/workflows/test.yml/badge.svg)](https://github.com/devskill-org/ems/actions/workflows/test.yml) +[![Coverage](https://codecov.io/gh/devskill-org/ems/branch/main/graph/badge.svg)](https://codecov.io/gh/devskill-org/ems) +[![Go Report Card](https://goreportcard.com/badge/github.com/devskill-org/ems)](https://goreportcard.com/report/github.com/devskill-org/ems) +[![Go Version](https://img.shields.io/github/go-mod/go-version/devskill-org/ems)](https://github.com/devskill-org/ems/blob/main/go.mod) +[![License](https://img.shields.io/github/license/devskill-org/ems)](https://github.com/devskill-org/ems/blob/main/LICENSE) A comprehensive Go-based Energy Management System that optimizes energy consumption, production, and storage across multiple sources including solar (PV), battery storage, grid connection, and controllable loads. The system uses real-time electricity price data, weather forecasts, and Model Predictive Control (MPC) to minimize energy costs while maintaining system reliability. @@ -143,7 +143,7 @@ The Energy Management System operates on multiple time scales: ### From Source ```bash -git clone https://github.com/devskill-org/energy-management-system.git +git clone https://github.com/devskill-org/ems.git cd energy-management-system go build -o ems ./ ``` @@ -525,8 +525,8 @@ This project is licensed under the terms specified in the [LICENSE](LICENSE) fil ## Support -- **Issues**: [GitHub Issues](https://github.com/devskill-org/energy-management-system/issues) -- **Discussions**: [GitHub Discussions](https://github.com/devskill-org/energy-management-system/discussions) +- **Issues**: [GitHub Issues](https://github.com/devskill-org/ems/issues) +- **Discussions**: [GitHub Discussions](https://github.com/devskill-org/ems/discussions) - **Documentation**: Check the `/docs` folder for detailed guides ## Roadmap @@ -537,4 +537,4 @@ This project is licensed under the terms specified in the [LICENSE](LICENSE) fil - [ ] Mobile app for remote monitoring - [ ] Multi-site management - [ ] Enhanced MPC algorithms -- [ ] Integration with home automation systems (Home Assistant, etc.) \ No newline at end of file +- [ ] Integration with home automation systems (Home Assistant, etc.) diff --git a/entsoe/api_client.go b/entsoe/api_client.go index 5ab0454..c226634 100644 --- a/entsoe/api_client.go +++ b/entsoe/api_client.go @@ -6,7 +6,7 @@ import ( "net/http" "time" - "github.com/devskill-org/energy-management-system/utils" + "github.com/devskill-org/ems/utils" ) // APIClient represents an HTTP client for the ENTSO-E API diff --git a/go.mod b/go.mod index 1d36a32..dd58e96 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/devskill-org/energy-management-system +module github.com/devskill-org/ems go 1.25.1 diff --git a/main.go b/main.go index 6ef8f1f..f470ae8 100644 --- a/main.go +++ b/main.go @@ -9,8 +9,8 @@ import ( "os/signal" "syscall" - "github.com/devskill-org/energy-management-system/scheduler" - "github.com/devskill-org/energy-management-system/sigenergy" + "github.com/devskill-org/ems/scheduler" + "github.com/devskill-org/ems/sigenergy" ) func main() { diff --git a/meteo/README.md b/meteo/README.md index 0137999..35e94a6 100644 --- a/meteo/README.md +++ b/meteo/README.md @@ -15,7 +15,7 @@ A Go client library for the [MET Norway Location Forecast API](https://api.met.n ## Installation ```bash -go get github.com/devskill-org/energy-management-system/meteo +go get github.com/devskill-org/ems/meteo ``` ## Quick Start @@ -27,7 +27,7 @@ import ( "fmt" "log" - "github.com/devskill-org/energy-management-system/meteo" + "github.com/devskill-org/ems/meteo" ) func main() { @@ -284,4 +284,4 @@ https://api.met.no/weatherapi/locationforecast/2.0/documentation ## Contributing -Contributions are welcome! Please feel free to submit a Pull Request. \ No newline at end of file +Contributions are welcome! Please feel free to submit a Pull Request. diff --git a/meteo/example/main.go b/meteo/example/main.go index 635f490..e190106 100644 --- a/meteo/example/main.go +++ b/meteo/example/main.go @@ -5,7 +5,7 @@ import ( "log" "time" - "github.com/devskill-org/energy-management-system/meteo" + "github.com/devskill-org/ems/meteo" ) func main() { diff --git a/mpc/example/main.go b/mpc/example/main.go index 82165fd..ae9e9ac 100644 --- a/mpc/example/main.go +++ b/mpc/example/main.go @@ -5,7 +5,7 @@ import ( "math" "time" - "github.com/devskill-org/energy-management-system/mpc" + "github.com/devskill-org/ems/mpc" ) // Example usage diff --git a/scheduler/miners.go b/scheduler/miners.go index 032408d..33c166e 100644 --- a/scheduler/miners.go +++ b/scheduler/miners.go @@ -6,7 +6,7 @@ import ( "sync" "time" - "github.com/devskill-org/energy-management-system/miners" + "github.com/devskill-org/ems/miners" ) // discoverMiners discovers Avalon miners on the network and stores them diff --git a/scheduler/miners_test.go b/scheduler/miners_test.go index f0ab7e9..7adf4b7 100644 --- a/scheduler/miners_test.go +++ b/scheduler/miners_test.go @@ -5,7 +5,7 @@ import ( "os" "testing" - "github.com/devskill-org/energy-management-system/miners" + "github.com/devskill-org/ems/miners" ) // This file contains unit tests for the controlMiner function in miners.go. diff --git a/scheduler/mpc.go b/scheduler/mpc.go index b3eccf0..0aa8edb 100644 --- a/scheduler/mpc.go +++ b/scheduler/mpc.go @@ -6,9 +6,9 @@ import ( "math" "time" - "github.com/devskill-org/energy-management-system/meteo" - "github.com/devskill-org/energy-management-system/mpc" - "github.com/devskill-org/energy-management-system/sigenergy" + "github.com/devskill-org/ems/meteo" + "github.com/devskill-org/ems/mpc" + "github.com/devskill-org/ems/sigenergy" "github.com/sixdouglas/suncalc" ) diff --git a/scheduler/pricing.go b/scheduler/pricing.go index ed5cab6..45781d4 100644 --- a/scheduler/pricing.go +++ b/scheduler/pricing.go @@ -5,7 +5,7 @@ import ( "fmt" "time" - "github.com/devskill-org/energy-management-system/entsoe" + "github.com/devskill-org/ems/entsoe" ) // GetPricesMarketData returns the cached PublicationMarketData without downloading diff --git a/scheduler/pv.go b/scheduler/pv.go index 13310e7..645fe54 100644 --- a/scheduler/pv.go +++ b/scheduler/pv.go @@ -5,8 +5,8 @@ import ( "sync" "time" - "github.com/devskill-org/energy-management-system/meteo" - "github.com/devskill-org/energy-management-system/sigenergy" + "github.com/devskill-org/ems/meteo" + "github.com/devskill-org/ems/sigenergy" ) type WeatherForecastCache struct { diff --git a/scheduler/scheduler.go b/scheduler/scheduler.go index 348cde7..749dd51 100644 --- a/scheduler/scheduler.go +++ b/scheduler/scheduler.go @@ -8,8 +8,8 @@ import ( "sync" "time" - "github.com/devskill-org/energy-management-system/entsoe" - "github.com/devskill-org/energy-management-system/miners" + "github.com/devskill-org/ems/entsoe" + "github.com/devskill-org/ems/miners" _ "github.com/lib/pq" ) diff --git a/scheduler/scheduler_test.go b/scheduler/scheduler_test.go index def5251..c723056 100644 --- a/scheduler/scheduler_test.go +++ b/scheduler/scheduler_test.go @@ -10,8 +10,8 @@ import ( "testing" "time" - "github.com/devskill-org/energy-management-system/entsoe" - "github.com/devskill-org/energy-management-system/miners" + "github.com/devskill-org/ems/entsoe" + "github.com/devskill-org/ems/miners" ) // mockEnergyPricesServer creates a mock HTTP server that returns valid energy prices XML