Skip to content

Latest commit

 

History

History
404 lines (290 loc) · 13.7 KB

README.dev.md

File metadata and controls

404 lines (290 loc) · 13.7 KB

Developer documentation

Welcome to TulipaEnergyModel.jl developer documentation. Here is how you can contribute to our Julia-based toolkit for modeling and optimization of electric energy systems.

Before You Begin

Before you can start contributing, please read our CONTRIBUTING.md.

Also make sure that you have installed the required software, and that it is properly configured. You only need to do this once.

Installing Software

To contribute to TulipaEnergyModel.jl, you need the following:

  1. Julia programming language.

  2. Git for version control.

  3. VSCode or any other editor. For VSCode, we recommend to install a few extensions. You can do it by pressing Ctrl + Shift + X (or ⇧ + ⌘ + X on MacOS) and searching by the extension name.

  4. EditorConfig for consistent code formatting. In VSCode, it is available as an extension.

  5. pre-commit to run the linters and formatters.

    You can install pre-commit globally using

    pip install --user pre-commit

    If you prefer to create a local environment with it, do the following:

    python -m venv env
. env/bin/activate
pip install --upgrade pip setuptools pre-commit

    On Windows, you need to active the environment using the following command instead of the previous one:

    . env/Scrips/activate

  6. JuliaFormatter.jl for code formatting. To install it, open Julia REPL, for example, by typing in the command line:

    julia

    Note: julia must be part of your environment variables to call it from the command line.

    Then press ] to enter the package mode. In the package mode, enter the following:

    pkg> activate
pkg> add JuliaFormatter

    In VSCode, you can activate "Format on Save" for JuliaFormatter. To do so, open VSCode Settings (Ctrl + ,), then in "Search Settings", type "Format on Save" and tick the first result:

    Screenshot of Format on Save option

  7. LocalCoverage for coverage testing. You can install it the same way you installed JuliaFormatter, that is, by opening Julia REPL in the package mode and typing:

    pkg> activate
pkg> add LocalCoverage

Forking the Repository

Any changes should be done in a fork. You can fork this repository directly on GitHub:

Screenshot of Fork button on GitHub

After that, clone your fork and add this repository as upstream:

git clone https://github.com/your-name/TulipaEnergyModel.jl                   # use the fork URL
git remote add upstream https://github.com/TulipaEnergy/TulipaEnergyModel.jl  # use the original repository URL

Configuring Git

Because operating systems use different line endings for text files, you need to configure Git to ensure code consistency across different platforms. You can do this with the following commands:

cd /path/to/TulipaEnergyModel.jl
git config --unset core.autocrlf         # disable autocrlf in the EnergyModel repo
git config --global core.autocrlf false  # explicitly disable autocrlf globally
git config --global --unset core.eol     # disable explicit file-ending globally
git config core.eol lf                   # set Linux style file-endings in EnergyModel

Activating and Testing the Package

Start Julia REPL either via the command line or in the editor.

In the terminal, do:

cd /path/to/TulipaEnergyModel.jl  # change the working directory to the repo directory if needed
julia                             # start Julia REPL

In VSCode, first open your cloned fork as a new project. Then open the command palette with Ctrl + Shift + P (or ⇧ + ⌘ + P on MacOS) and use the command called Julia: Start REPL.

In Julia REPL, enter the package mode by pressing ].

In the package mode, first activate and instantiate the project, then run the tests to ensure that everything is working as expected:

pkg> activate .   # activate the project
pkg> instantiate  # instantiate to install the required packages
pkg> test         # run the tests

Configuring Linting and Formatting

With pre-commit installed, activate it as a pre-commit hook:

pre-commit install

To run the linting and formatting manually, enter the command below:

pre-commit run -a

Do it once now to make sure that everything works as expected.

Now, you can only commit if all the pre-commit tests pass.

Note: On subsequent occasions when you need to run pre-commit in a new shell, you will need to activate the Python virtual environment. If so, do the following:

. env/bin/activate  # for Windows the command is: . env/Scripts/activate
pre-commit run -a

Contributing Workflow

When the software is installed and configured, and you have forked the TulipaEnergyModel.jl repository, you can start contributing to it.

We use the following workflow for all contributions:

  1. Make sure that your fork is up to date
  2. Create a new branch
  3. Implement the changes
  4. Run the tests
  5. Run the linter
  6. Commit the changes
  7. Repeat steps 3-6 until all necessary changes are done
  8. Make sure that your fork is still up to date
  9. Create a pull request

Below you can find detailed instructions for each step.

1. Make Sure That Your Fork Is Up to Date

Fetch from org remote, fast-forward your local main:

git switch main
git fetch --all --prune
git merge --ff-only origin/main

Warning: If you have a conflict on your main, it will appear now. You can delete your old main branch using

git reset --hard origin/main

2. Create a New Branch

Create a branch to address the issue:

git switch -c <branch_name>
  • If there is an associated issue, add the issue number to the branch name, for example, 123-short-description for issue #123.
  • If there is no associated issue and the changes are small, add a prefix such as "typo", "hotfix", "small-refactor", according to the type of update.
  • If the changes are not small and there is no associated issue, then create the issue first, so we can properly discuss the changes.

Note: Always branch from main, i.e., the main branch of your own fork.

3. Implement the Changes

Implement your changes to address the issue associated with the branch.

4. Run the Tests

In Julia:

TulipaEnergyModel> test

To run the tests with code coverage, you can use the LocalCoverage package:

julia> using LocalCoverage
# ]
pkg> activate .
# <backspace>
julia> cov = generate_coverage()

This will run the tests, track line coverage and print a report table as output. Note that we want to maintain 100% test coverage. If any file does not show 100% coverage, please add tests to cover the missing lines.

If you are having trouble reaching 100% test coverage, you can set your pull request to 'draft' status and ask for help.

5. Run the Linter

In the bash/git bash terminal, run pre-commit:

. env/bin/activate # if necessary (for Windows the command is: . env/Scripts/activate)
pre-commit run -a

If any of the checks failed, find in the pre-commit log what the issues are and fix them. Then, add them again (git add), rerun the tests & linter, and commit.

6. Commit the Changes

When the test are passing, commit the changes and push them to the remote repository. Use:

git commit -am "A short but descriptive commit message" # Equivalent to: git commit -a -m "commit msg"
git push -u myfork <branch_name>

When writing the commit message:

  • use imperative, present tense (Add feature, Fix bug);
  • have informative titles;
  • if necessary, add a body with details.

Note: Try to create "atomic git commits". Read The Utopic Git History to learn more.

7. Make Sure That Your Fork Is Still Up to Date

If necessary, fetch any main updates from upstream and rebase your branch into origin/main. For example, do this if it took some time to resolve the issue you have been working on. If you don't resolve conflicts locally, you will get conflicts in your pull request.

Do the following steps:

git switch main                  # switch to the main branch
git fetch --all --prune          # fetch the updates
git merge --ff-only origin/main  # merge as a fast-forward
git switch <branch_name>         # switch back to the issue branch
git rebase main <branch_name>    # rebase it

If it says that you have conflicts, resolve them by opening the file(s) and editing them until the code looks correct to you. You can check the changes with:

git diff             # Check that changes are correct.
git add <file_name>
git diff --staged    # Another way to check changes, i.e., what you will see in the pull request.

Once the conflicts are resolved, commit and push.

git status # Another way to show that all conflicts are fixed.
git rebase --continue
git push --force myfork <branch_name>

8. Create a Pull Request

When there are no more conflicts and all the test are passing, create a pull request to merge your remote branch into the org main. You can do this on GitHub by opening the branch in your fork and clicking "Compare & pull request".

Screenshot of Compare & pull request button on GitHub

Fill in the pull request details:

  1. Describe the changes.
  2. List the issue(s) that this pull request closes.
  3. Fill in the collaboration confirmation.
  4. (Optional) Choose a reviewer.
  5. When all of the information is filled in, click "Create pull request".

Screenshot of the pull request information

You pull request will apper in the list of pull requests in the TulipaEnergyModel.jl repository, where you can track the review process.

Sometimes reviewers request changes. After pushing any changes, the pull request will be automatically updated. Do not forget to re-request a review.

Once your reviewer approves the pull request, you need to merge it with the main branch using "Squash and Merge". You can also delete the branch that originated the pull request by clicking the button that appears after the merge. For branches that were pushed to the main repo, it is recommended that you do so.

Performance Considerations

If you updated something that might impact the performance of the package, you can run the Benchmark.yml workflow from your pull request. To do that, add the tag benchmark in the pull request. This will trigger the workflow and post the results as a comment in you pull request.

Warning: This requires that your branch was pushed to the main repo. If you have created a pull request from a fork, the Benchmark.yml workflow does not work. Instead, close your pull request, push your branch to the main repo, and open a new pull request.

If you want to manually run the benchmarks, you can do the following:

  • Navigate to the benchmark folder

  • Run julia --project=.

  • Enter pkg mode by pressing ]

  • Run dev .. to add the development version of TulipaEnergyModel

  • Now run

    include("benchmarks.jl")
tune!(SUITE)
results = run(SUITE, verbose=true)

Profiling

To profile the code in a more manual way, here are some tips:

  • Wrap your code into functions.
  • Call the function once to precompile it. This must be done after every change to the function.
  • Prefix the function call with @time. This is the most basic timing, part of Julia.
  • Prefix the function call with @btime. This is part of the BenchmarkTools package, which you might need to install. @btime will evaluate the function a few times to give a better estimate.
  • Prefix the function call with @benchmark. Also part of BenchmarkTools. This will produce a nice histogram of the times and give more information. @btime and @benchmark do the same thing in the background.
  • Call @profview. This needs to be done in VSCode, or using the ProfileView package. This will create a flame graph, where each function call is a block. The size of the block is proportional to the aggregate time it takes to run. The blocks below a block are functions called inside the function above.

See the file <benchmark/profiling.jl> for an example of profiling code.

Building the Documentation Locally

To build and see the documentation locally, first, navigate to the docs folder in your file explorer and open a terminal. Then, run julia --project. With the julia open, enter the pkg mode by pressing ]. Check that the environment name is docs. The first time here, you have to run:

docs> dev ..
docs> update

Then, to build the documentation, run

julia> include("make.jl")

If you intend to rerun the build step, ensure you have the package Revise installed in your global environment, and run using Revise before including make.jl. Alternatively, close julia and reopen it.

After building, the documentation will be available in the folder docs/build/. Open the index.html file on the browser to see it.