Feature/rename to flixopt (#208)

* rename package to flixopt

* update .yaml and pyproject

* Using FlixOpt as the name in text and flixopt everywhere else

* Using FlixOpt as the name in text and flixopt everywhere else

Author: FBumann

.github/workflows/python-app.yaml

@@ -99,7 +99,7 @@ jobs:
           (sleep 30 && pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ $PACKAGE_NAME) || \
           (sleep 60 && pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ $PACKAGE_NAME)
           # Basic import test
-          python -c "import flixOpt; print('Installation successful!')"
+          python -c "import flixopt; print('Installation successful!')"
 
   publish-pypi:
     name: Publish to PyPI
@@ -144,4 +144,4 @@ jobs:
           # Install from PyPI
           pip install $PACKAGE_NAME
           # Basic import test
-          python -c "import flixOpt; print('PyPI installation successful!')"
+          python -c "import flixopt; print('PyPI installation successful!')"

README.md

@@ -1,4 +1,4 @@
-# flixOpt: Energy and Material Flow Optimization Framework
+# FlixOpt: Energy and Material Flow Optimization Framework
 
 [![📚 Documentation](https://img.shields.io/badge/📚_docs-online-brightgreen.svg)](https://flixopt.github.io/flixopt/)
 [![CI](https://github.com/flixOpt/flixopt/actions/workflows/python-app.yaml/badge.svg)](https://github.com/flixOpt/flixopt/actions/workflows/python-app.yaml)
@@ -18,7 +18,7 @@
 
 **flixopt** provides a user-friendly interface with options for advanced users.
 
-It was originally developed by [TU Dresden](https://github.com/gewv-tu-dresden) as part of the SMARTBIOGRID project, funded by the German Federal Ministry for Economic Affairs and Energy (FKZ: 03KB159B). Building on the Matlab-based flixOptMat framework (developed in the FAKS project), flixOpt also incorporates concepts from [oemof/solph](https://github.com/oemof/oemof-solph). 
+It was originally developed by [TU Dresden](https://github.com/gewv-tu-dresden) as part of the SMARTBIOGRID project, funded by the German Federal Ministry for Economic Affairs and Energy (FKZ: 03KB159B). Building on the Matlab-based flixOptMat framework (developed in the FAKS project), FlixOpt also incorporates concepts from [oemof/solph](https://github.com/oemof/oemof-solph). 
 
 ---
 
@@ -50,11 +50,11 @@ It was originally developed by [TU Dresden](https://github.com/gewv-tu-dresden)
 
 ## 📦 Installation
 
-Install flixOpt via pip.
+Install FlixOpt via pip.
 `pip install flixopt`
 With [HiGHS](https://github.com/ERGO-Code/HiGHS?tab=readme-ov-file) included out of the box, flixopt is ready to use..
 
-We recommend installing flixOpt with all dependencies, which enables additional features like interactive network visualizations ([pyvis](https://github.com/WestHealth/pyvis)) and time series aggregation ([tsam](https://github.com/FZJ-IEK3-VSA/tsam)).
+We recommend installing FlixOpt with all dependencies, which enables additional features like interactive network visualizations ([pyvis](https://github.com/WestHealth/pyvis)) and time series aggregation ([tsam](https://github.com/FZJ-IEK3-VSA/tsam)).
 `pip install "flixopt[full]"`
 
 ---
@@ -67,7 +67,7 @@ The documentation is available at [https://flixopt.github.io/flixopt/](https://f
 
 ## 🛠️ Solver Integration
 
-By default, flixOpt uses the open-source solver [HiGHS](https://highs.dev/) which is installed by default. However, it is compatible with additional solvers such as:  
+By default, FlixOpt uses the open-source solver [HiGHS](https://highs.dev/) which is installed by default. However, it is compatible with additional solvers such as:  
 
 - [Gurobi](https://www.gurobi.com/)  
 - [CBC](https://github.com/coin-or/Cbc)  
@@ -80,7 +80,7 @@ For detailed licensing and installation instructions, refer to the respective so
 
 ## 📖 Citation
 
-If you use flixOpt in your research or project, please cite the following:  
+If you use FlixOpt in your research or project, please cite the following:  
 
 - **Main Citation:** [DOI:10.18086/eurosun.2022.04.07](https://doi.org/10.18086/eurosun.2022.04.07)  
 - **Short Overview:** [DOI:10.13140/RG.2.2.14948.24969](https://doi.org/10.13140/RG.2.2.14948.24969)  

docs/contribute.md

@@ -8,7 +8,7 @@ We warmly welcome contributions from the community! This guide will help you get
 3. Run `pytest` and `ruff check .` to ensure your code passes all tests
 
 ## Documentation
-flixOpt uses [mkdocs](https://www.mkdocs.org/) to generate documentation. To preview the documentation locally, run `mkdocs serve` in the root directory.
+FlixOpt uses [mkdocs](https://www.mkdocs.org/) to generate documentation. To preview the documentation locally, run `mkdocs serve` in the root directory.
 
 ## Helpful Commands
 - `mkdocs serve` to preview the documentation locally. Navigate to `http://127.0.0.1:8000/` to view the documentation.
@@ -28,7 +28,7 @@ flixOpt uses [mkdocs](https://www.mkdocs.org/) to generate documentation. To pre
 - Ensure 100% test coverage for new code
 
 ## Branches
-As we start to think flixOpt in **Releases**, we decided to introduce multiple **dev**-branches instead of only one:
+As we start to think FlixOpt in **Releases**, we decided to introduce multiple **dev**-branches instead of only one:
 Following the **Semantic Versioning** guidelines, we introduced:
 - `next/patch`: This is where all pull requests for the next patch release (1.0.x) go.  
 - `next/minor`: This is where all pull requests for the next minor release (1.x.0) go.  

docs/examples/03-Calculation Modes.md

@@ -1,5 +1,5 @@
 # Calculation Mode comparison
-**Note:** This example relies on time series data. You can find it in the `examples` folder of the flixOpt repository.
+**Note:** This example relies on time series data. You can find it in the `examples` folder of the FlixOpt repository.
 ```python
 {! ../examples/03_Calculation_types/example_calculation_types.py !}
 ```

docs/examples/index.md

@@ -1,5 +1,5 @@
 # Examples
 
-Here you can find a collection of examples that demonstrate how to use flixOpt.
+Here you can find a collection of examples that demonstrate how to use FlixOpt.
 
 We work on improving this gallery. If you have something to share, please contact us!

docs/faq/contribute.md

@@ -8,7 +8,7 @@ We warmly welcome contributions from the community! This guide will help you get
 3. Run `pytest` and `ruff check .` to ensure your code passes all tests
 
 ## Documentation
-flixOpt uses [mkdocs](https://www.mkdocs.org/) to generate documentation. To preview the documentation locally, run `mkdocs serve` in the root directory.
+FlixOpt uses [mkdocs](https://www.mkdocs.org/) to generate documentation. To preview the documentation locally, run `mkdocs serve` in the root directory.
 
 ## Helpful Commands
 - `mkdocs serve` to preview the documentation locally. Navigate to `http://127.0.0.1:8000/` to view the documentation.
@@ -28,7 +28,7 @@ flixOpt uses [mkdocs](https://www.mkdocs.org/) to generate documentation. To pre
 - Ensure 100% test coverage for new code
 
 ## Branches
-As we start to think flixOpt in **Releases**, we decided to introduce multiple **dev**-branches instead of only one:
+As we start to think FlixOpt in **Releases**, we decided to introduce multiple **dev**-branches instead of only one:
 Following the **Semantic Versioning** guidelines, we introduced:
 - `next/patch`: This is where all pull requests for the next patch release (1.0.x) go.  
 - `next/minor`: This is where all pull requests for the next minor release (1.x.0) go.  

docs/getting-started.md

@@ -1,12 +1,12 @@
-# Getting Started with flixOpt
+# Getting Started with FlixOpt
 
-This guide will help you install flixOpt, understand its basic concepts, and run your first optimization model.
+This guide will help you install FlixOpt, understand its basic concepts, and run your first optimization model.
 
 ## Installation
 
 ### Basic Installation
 
-Install flixOpt directly into your environment using pip:
+Install FlixOpt directly into your environment using pip:
 
 ```bash
 pip install flixopt
@@ -24,19 +24,19 @@ pip install "flixopt[full]""
 
 ## Basic Workflow
 
-Working with flixOpt follows a general pattern:
+Working with FlixOpt follows a general pattern:
 
-1. **Create a [`FlowSystem`][flixOpt.flow_system.FlowSystem]** with a time series
-2. **Define [`Effects`][flixOpt.effects.Effect]** (costs, emissions, etc.)
-3. **Define [`Buses`][flixOpt.elements.Bus]** as connection points in your system
-4. **Add [`Components`][flixOpt.components]** like converters, storage, sources/sinks with their Flows
-5. **Run [`Calculations`][flixOpt.calculation]** to optimize your system
-6. **Analyze [`Results`][flixOpt.results]** using built-in or external visualization tools
+1. **Create a [`FlowSystem`][flixopt.flow_system.FlowSystem]** with a time series
+2. **Define [`Effects`][flixopt.effects.Effect]** (costs, emissions, etc.)
+3. **Define [`Buses`][flixopt.elements.Bus]** as connection points in your system
+4. **Add [`Components`][flixopt.components]** like converters, storage, sources/sinks with their Flows
+5. **Run [`Calculations`][flixopt.calculation]** to optimize your system
+6. **Analyze [`Results`][flixopt.results]** using built-in or external visualization tools
 
 ## Next Steps
 
-Now that you've installed flixOpt and understand the basic workflow, you can:
+Now that you've installed FlixOpt and understand the basic workflow, you can:
 
-- Learn about the [core concepts of flixOpt](user-guide/index.md)
+- Learn about the [core concepts of FlixOpt](user-guide/index.md)
 - Explore some [examples](examples/)
 - Check the [API reference](api-reference/index.md) for detailed documentation

docs/index.md

@@ -21,8 +21,8 @@ FlixOpt is designed as a general-purpose optimization framework to get your mode
 - **Results File I/O**: Built to analyze results independent of running the optimization.
 
 <figure markdown>
-  ![flixOpt Conceptual Usage](./images/architecture_flixOpt.png)
-  <figcaption>Conceptual Usage and IO operations of flixOpt</figcaption>
+  ![FlixOpt Conceptual Usage](./images/architecture_flixOpt.png)
+  <figcaption>Conceptual Usage and IO operations of FlixOpt</figcaption>
 </figure>
 
 ## Installation

docs/release-notes/v2.0.0.md

@@ -56,7 +56,7 @@ This access doesn't change if you save and load the results to a file or use the
 
 ## 📚 Documentation
 
-- Imporved documentation of the flixOpt API and mathematical formulations
+- Improved documentation of the FlixOpt API and mathematical formulations
 - **Google Style Docstrings**: Updated all docstrings to Google style format
 
 ## 🔄 Dependencies

docs/user-guide/Mathematical Notation/Effects, Penalty & Objective.md

@@ -1,10 +1,10 @@
 ## Effects
-[`Effects`][flixOpt.effects.Effect] are used to allocate things like costs, emissions, or other "effects" occuring in the system.
+[`Effects`][flixopt.effects.Effect] are used to allocate things like costs, emissions, or other "effects" occuring in the system.
 These arise from so called **Shares**, which originate from **Elements** like [Flows](Flow.md).
 
 **Example:**
 
-[`Flows`][flixOpt.elements.Flow] have an attribute called `effects_per_flow_hour`, defining the effect amount of per flow hour.
+[`Flows`][flixopt.elements.Flow] have an attribute called `effects_per_flow_hour`, defining the effect amount of per flow hour.
 Assiziated effects could be:
 - costs - given in [€/kWh]...
 - ...or emissions - given in [kg/kWh].
@@ -98,7 +98,7 @@ $$
 
 ## Penalty
 
-Additionally to the user defined [Effects](#effects), a Penalty $\Phi$ is part of every flixOpt Model.
+Additionally to the user defined [Effects](#effects), a Penalty $\Phi$ is part of every FlixOpt Model.
 Its used to prevent unsolvable problems and simplify troubleshooting.
 Shares to the penalty can originate from every Element and are constructed similarly to 
 $\eqref{Share_invest}$ and  $\eqref{Share_operation}$.
@@ -117,7 +117,7 @@ At the moment, penalties only occur in [Buses](#buses)
 
 ## Objective
 
-The optimization objective of a flixOpt Model is defined as $\eqref{eq:Objective}$
+The optimization objective of a FlixOpt Model is defined as $\eqref{eq:Objective}$
 $$ \label{eq:Objective}
 \min(E_{\Omega} + \Phi)
 $$