Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs update #592

Merged
merged 3 commits into from
Feb 27, 2023
Merged

Docs update #592

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4777dc0
Add pycharm dir to gitignore
pimsauter Feb 25, 2023
6bff3d8
Add docs fixes
pimsauter Feb 25, 2023
1e964c2
Add note about port 5000 on mac
pimsauter Feb 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ venv
*.rdb
*.rdb.settings
*.pickle
.idea/

.env-flexmeasures/
flexmeasures.egg-info
Expand Down
2 changes: 1 addition & 1 deletion documentation/dev/docker-compose.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Running a complete stack with docker-compose

To install FlexMeasures, plus the libraries and databases it depends on, on your computer is some work, and can have unexpected hurdles, e.g. depending on the operating system. A nice alternative is to let that happen within Docker. The whole stack can be run via `Docker compose <https://docs.docker.com/compose/>`_, saving the developer much time.

For this, we assume you are in the directory housing ``docker-compose.yml``.
For this, we assume you are in the directory (in the `FlexMeasures git repository <https://github.com/FlexMeasures/flexmeasures>`_) housing ``docker-compose.yml``.


.. note:: The minimum Docker version is 17.09 and for docker-compose we tested successfully at version 1.25. You can check your versions with ``docker[-compose] --version``.
Expand Down
2 changes: 1 addition & 1 deletion documentation/tut/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,6 @@ Then, start workers in a console (or some other method to keep a long-running pr
Where to go from here?
------------------------

If your data structure is good, you should think about (continually) adding measurement data. This tutorial mentioned how to add data, but :ref:`_tut_posting_data` goes deeper with examples and terms & definitions.
If your data structure is good, you should think about (continually) adding measurement data. This tutorial mentioned how to add data, but :ref:`tut_posting_data` goes deeper with examples and terms & definitions.

Then, you probably want to use FlexMeasures to generate forecasts and schedules! For this, read further in :ref:`tut_forecasting_scheduling`.
2 changes: 1 addition & 1 deletion documentation/tut/toy-example-from-scratch.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Install Flexmeasures and the database

$ docker exec -it flexmeasures-tutorial-fm bash

To leave the container session, hold CTRL-C or type "exit".
To leave the container session, hold CTRL-D or type "exit".

To stop the containers, you can type

Expand Down