chore: first steps - cleanup docs, merge contents into iesopt docs, r…

…emove leftovers

README.md

@@ -24,6 +24,16 @@ while still being user-friendly. This is enabled by reducing energy system asset
 supported by specialized implementation, and can be combined into complex systems without the need of a detailed
 understanding of mathematical modeling or proficiency in any coding-language.
 
+## MERGING DOCUMENTATIONS
+
+> We are currently merging this documentation into the (now) central one, over at working [iesopt](https://github.com/ait-energy/iesopt). Besides migrating everything, this requires some clean-up of
+> (potentially) confindential left-overs (e.g., from projects), so the documentation needs to be checked page-by-page. If you are trying to
+> get started before we manage to fix everything, get in touch with us directly - we'll help you set up everything you
+> need. Leftovers can be seen in #4c2a59c or earlier. Information in the current Julia documentation as well as in this README may be outdated!
+
+---
+---
+
 ## Table of Contents
 
 - [Background](#background)
@@ -47,9 +57,9 @@ in the documentation, both for Python and Julia. Depending on your use-case, and
 there are different ways to get started. If you are experienced with Julia, and want to interact with the core model
 itself, then using `IESopt.jl` directly will suit you best. If you are looking for a more user-friendly interaction, or
 are new to energy system modeling and/or coding at all, you might want to check out the Python wrapper
-[iesopt-py](https://github.com/ait-energy/iesopt-py).
+[iesopt](https://github.com/ait-energy/iesopt).
 
-> If you are not 110% sure where to start... start here: [iesopt](https://github.com/ait-energy/iesopt-py)
+> If you are not 110% sure where to start... start here: [iesopt](https://github.com/ait-energy/iesopt)
 
 ### Quick setup for Julia
 
@@ -62,11 +72,11 @@ activated (e.g., do `activate .`), then add the package with the following comma
 
 ### Quick setup for Python
 
-Head over to [iesopt-py](https://github.com/ait-energy/iesopt-py) and follow the instructions there, or - if you already
+Head over to [iesopt](https://github.com/ait-energy/iesopt) and follow the instructions there, or - if you already
 have a working Python environment - install the package, e.g., via `poetry`:
 
 ```bash
-poetry add iesopt-py
+poetry add iesopt
 ```
 
 ## Usage
@@ -126,7 +136,7 @@ IESopt.optimize!(model::JuMP.Model; save_results::Bool=true, kwargs...)
 IESopt.run(filename::String; verbosity=nothing, kwargs...)
 
 """Get the component with the name `component_name` from the `model`."""
-IESopt.component(model::JuMP.Model, component_name::String)
+IESopt.get_component(model::JuMP.Model, component_name::String)
 
 """Compute the Irreducible Infeasible Set (IIS) of the model."""
 IESopt.compute_IIS(model::JuMP.Model; filename::String = "")

docs/src/index.md

@@ -9,69 +9,13 @@ It is written in Julia, and uses [JuMP](https://github.com/jump-dev/JuMP.jl) pac
 mathematical optimization models, and to interface with various solvers. The model is designed to be modular, and allows
 for easy extension and customization.
 
-```@meta
-# TODO: add "The main functionalities of IESopt.jl are: ..." itemize here.
-# TODO: add gitter here
-# TODO: cleanup the "About" section, and integrate it here
-```
-
 Check out the following GitHub repositories for more information:
 
 - [IESopt.jl](https://github.com/ait-energy/IESopt.jl), the core model (a Julia package).
-- [iesopt-py](https://github.com/ait-energy/iesopt-py), the Python interface.
+- [iesopt](https://github.com/ait-energy/iesopt), the Python interface.
 
-!!! danger "Moving to open-source"
-    We are currently working (hard) on getting IESopt fully open-source on GitHub, which requires some clean-up of
-    (potentially) confindential left-overs (e.g., from projects). Meanwhile, a lot of internals are changing (after
-    staying fixed for a long time), and the documentation needs to be checked page-by-page. If you are trying to
+!!! danger "Merging documentations"
+    We are currently merging this documentation into the (now) central one, over at working [iesopt](https://github.com/ait-energy/iesopt). Besides migrating everything, this requires some clean-up of
+    (potentially) confindential left-overs (e.g., from projects), so the documentation needs to be checked page-by-page. If you are trying to
     get started before we manage to fix everything, get in touch with us directly - we'll help you set up everything you
-    need. The documentation currently consists of mostly structured pages, with the content being added as soon as
-    possible.
-
-## Installation
-
-!!! details "Using Python"
-    To be added.
-
-!!! details "Using Julia"
-    To be added.
-
-## Citation
-
-If you find IESopt useful in your work, and are intend to publish or document your modeling, we kindly request that you
-include the following citation:
-
-- **Style: APA7**
-  > Strömer, S., Schwabeneder, D., & contributors. (2021-2024). _IESopt: Integrated Energy System Optimization_ [Software]. AIT Austrian Institute of Technology GmbH. [https://github.com/ait-energy/IESopt](https://github.com/ait-energy/IESopt)
-- **Style: IEEE**
-  > [1] S. Strömer, D. Schwabeneder, and contributors, _"IESopt: Integrated Energy System Optimization,"_ AIT Austrian Institute of Technology GmbH, 2021-2024. [Online]. Available: [https://github.com/ait-energy/IESopt](https://github.com/ait-energy/IESopt)
-- **BibTeX:**
-  ```bibtex
-  @misc{iesopt,
-      author = {Strömer, Stefan and Schwabeneder, Daniel and contributors},
-      title = {{IES}opt: Integrated Energy System Optimization},
-      organization = {AIT Austrian Institute of Technology GmbH},
-      url = {https://github.com/ait-energy/IESopt},
-      type = {Software},
-      year = {2021-2024},
-  }
-  ```
-
-```@meta
-# ## About
-
-# ### Overview
-
-# IESopt, _Integrated Energy System Optimization_, is a general purpose energy system optimization framework, developed at the [Center for Energy](https://www.ait.ac.at/en/about-the-ait/center/center-for-energy), at [AIT Austrian Institute of Technology GmbH](https://www.ait.ac.at/), mainly developed and maintained by the unit [Integrated Energy Systems](https://www.ait.ac.at/en/research-topics/integrated-energy-systems).
-
-# ### Feature summary
-
-# What IESopt is, may be, and is not:
-
-# - YES
-#   - IESopt is a general purpose energy system (optimization) model. It supports multiple solvers (using `JuMP.jl` to interface with them) as well as a standardized way to build up models using "core components".
-# - MAYBE
-#   - IESopt.jl is not branded as JuMP extension. It plays nicely with JuMP, and some extensions, but we currently do not see it as a fully fledged JuMP extension. That, e.g., entails that `copy_extension_data` is not implemented at the moment, so `copy_model` is not supported. This is a deliberate choice, and may be changed in the - near or far - future.
-# - NO (really ...)
-#   - A full energy system model, in the sense of "containing data". There are a lot of good, and open, data sources out there from other teams, consider using them.
-```
+    need.