Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
OuyangWenyu committed Aug 15, 2024
1 parent 9f9df57 commit f5f0096
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,34 @@ You can use the CAMELS dataset (see [here](https://github.com/OuyangWenyu/hydrod

If CAMELS is used, you can skip this step.

If the warning "hydro_setting.yml not found" is shown, you can create a hydro_setting.yml file in the user directory. In windows, it is usually "C:/Users/<your_username>". In Linux, it is usually "/home/<your_username>". The content of the file is as follows:

```yaml
# Update the following with your own settings, if you don't have, you can ignore it
minio:
server_url: ''
client_endpoint: ''
access_key: ''
secret: ''
local_data_path:
root: ''
datasets-origin: ''
datasets-interim: ''
basins-origin: ''
basins-interim: ''
postgres:
server_url: ''
port: 5432
username: ''
password: ''
database: ''
```
To use your own data to run the model, you need prepare the data in the required format.
**NOTE: We currently only support calibrating one basin at a time, although the following instructions cover multiple basin information, we have not thoroughly tested it.**
We provide some transformation functions in the "scripts" directory. You can use them to transform your data to the required format.
But you still need to do some manual work before transformation. Here are the steps:
Expand Down

0 comments on commit f5f0096

Please sign in to comment.