-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
18e4a69
commit 85cd23f
Showing
7 changed files
with
58 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +0,0 @@ | ||
|
||
[submodule "workflow/scripts/subworkflows/pypsa-eur"] | ||
path = workflow/scripts/subworkflows/pypsa-eur | ||
url = [email protected]:PyPSA/pypsa-eur.git | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,27 +2,20 @@ | |
|
||
## Step 1. Clone GitHub Repository | ||
|
||
Users can clone the repository using HTTPS, SSH, or GitHub CLI. Ensure you retrieve the submodules in the repository when cloning, using the `--recurse-submodules` flag. See [GitHub docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for information on the different cloning methods. If you run into issues, follow GitHub troubleshooting suggestions [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors#https-cloning-errors). | ||
Users can clone the repository using HTTPS, SSH, or GitHub CLI. See [GitHub docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for information on the different cloning methods. If you run into issues, follow GitHub troubleshooting suggestions [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors#https-cloning-errors). | ||
|
||
```{note} | ||
If the repository is cloned without the `--recurse-submodules` flag, run the following commands. | ||
### Using HTTPS | ||
|
||
$ git submodule init | ||
$ git submodule update | ||
```bash | ||
$ git clone https://github.com/PyPSA/pypsa-usa.git | ||
``` | ||
|
||
### Using SSH-Key | ||
|
||
If it your first time cloning a **repository through ssh**, you will need to set up your git with an ssh-key by following these [directions](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). | ||
|
||
```bash | ||
$ git clone --recurse-submodules [email protected]:PyPSA/pypsa-usa.git | ||
``` | ||
|
||
### Using HTTPS | ||
|
||
```bash | ||
$ git clone --recurse-submodules https://github.com/PyPSA/pypsa-usa.git | ||
$ git clone [email protected]:PyPSA/pypsa-usa.git | ||
``` | ||
|
||
## Step 2. Initialize Configuration files | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# -*- coding: utf-8 -*- | ||
# SPDX-FileCopyrightText: : 2020-2024 The PyPSA-Eur Authors | ||
# | ||
# SPDX-License-Identifier: MIT | ||
""" | ||
Copy used configuration files and important scripts for archiving. | ||
""" | ||
|
||
|
||
import yaml | ||
from _helpers import set_scenario_config | ||
|
||
if __name__ == "__main__": | ||
if "snakemake" not in globals(): | ||
from _helpers import mock_snakemake | ||
|
||
snakemake = mock_snakemake("copy_config") | ||
|
||
set_scenario_config(snakemake) | ||
|
||
with open(snakemake.output[0], "w") as yaml_file: | ||
yaml.dump( | ||
snakemake.config, | ||
yaml_file, | ||
default_flow_style=False, | ||
allow_unicode=True, | ||
sort_keys=False, | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters