Skip to content

Commit ca5bb2b

Browse files
authored
Merge pull request #107 from ocean-tracking-network/main-changes
Changed references to master branch to main
2 parents 3dcc440 + bd2b525 commit ca5bb2b

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

_episodes/12_vis_notebooks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ keypoints:
2020
# The data sources:
2121
## The `discovery` schema
2222

23-
The `discovery` schema of each node, as well as the OTN database's own discovery schema, contains summarized data products that are meant to be quick shortcuts to analysis and reporting of popular data types. Here you can downsize the number of columns that accompany tag or receiver deployments, or bin up detections into easier-to-visualize bites. Simplified versions of these data types can also help you adhere to your Data Sharing Agreement with your user base, removing or generalizing the data according to what the community demands. The content of these tables is written by the [discovery_process_reload.ipynb](https://gitlab.oceantrack.org/otn-partner-nodes/ipython-utilities/-/blob/master/discovery_process_reload.ipynb) notebook, and the aggregation of the core discovery tables to the OTN database for aggregate reporting is performed by the [discovery_process_pull_node_tables_to_mstr.ipynb](https://gitlab.oceantrack.org/otn-partner-nodes/ipython-utilities/-/blob/master/discovery_process_pull_node_tables_to_mstr.ipynb) notebook. OTN does this for the purpose of reporting to funders, and helping with discoverability of datasets by publishing project pages with receiver and tag release location data for each project. If there are data that you do not want to supply to OTN for publication, you do not have to run those parts of the discovery process. Those data summaries will not be created or harvested by OTN during the discovery process phase of the [Data Push](./14_The%20Push.md).
23+
The `discovery` schema of each node, as well as the OTN database's own discovery schema, contains summarized data products that are meant to be quick shortcuts to analysis and reporting of popular data types. Here you can downsize the number of columns that accompany tag or receiver deployments, or bin up detections into easier-to-visualize bites. Simplified versions of these data types can also help you adhere to your Data Sharing Agreement with your user base, removing or generalizing the data according to what the community demands. The content of these tables is written by the [discovery_process_reload.ipynb](https://gitlab.oceantrack.org/otn-partner-nodes/ipython-utilities/-/blob/main/discovery_process_reload.ipynb) notebook, and the aggregation of the core discovery tables to the OTN database for aggregate reporting is performed by the [discovery_process_pull_node_tables_to_mstr.ipynb](https://gitlab.oceantrack.org/otn-partner-nodes/ipython-utilities/-/blob/main/discovery_process_pull_node_tables_to_mstr.ipynb) notebook. OTN does this for the purpose of reporting to funders, and helping with discoverability of datasets by publishing project pages with receiver and tag release location data for each project. If there are data that you do not want to supply to OTN for publication, you do not have to run those parts of the discovery process. Those data summaries will not be created or harvested by OTN during the discovery process phase of the [Data Push](./14_The%20Push.md).
2424

2525
## The `geoserver` schema
2626

2727
The `geoserver` schema is similar to the `discovery` schema but all data tables here correspond to layers that can be expressed via the [OGC GeoServer](https://geoserver.org) data portal. This means they have pre-calculated the geometric and map projection data columns necessary for them to express themselves as geographic data points and paths. This data is often stored in a column called `the_geom`.
2828

29-
If you re-generate these tables for your Node using the [populate_geoserver](https://gitlab.oceantrack.org/otn-partner-nodes/ipython-utilities/-/blob/master/geoserver%20-%20populate%20geoserver%20tables.ipynb) notebooks, they will then contain accurate data for your Node. Attaching a GeoServer instance to this database schema will allow you to express project, receiver deployment, and tag deployment information in many formats. [OTN's GeoServer](https://geoserver.oceantrack.org/) instance can aggregate and re-format the GeoServer data into human and machine-readable formats for creating public maps and data products. As an example: the OTN Members Portal uses GeoServer to visualize project data, and the [R package `otndo`](https://otndo.obrien.page) uses the existence of a GeoServer with station histories to produce data summaries for individual researchers about the places and times their tags were detected outside their own arrays.
29+
If you re-generate these tables for your Node using the [populate_geoserver](https://gitlab.oceantrack.org/otn-partner-nodes/ipython-utilities/-/blob/main/geoserver%20-%20populate%20geoserver%20tables.ipynb) notebooks, they will then contain accurate data for your Node. Attaching a GeoServer instance to this database schema will allow you to express project, receiver deployment, and tag deployment information in many formats. [OTN's GeoServer](https://geoserver.oceantrack.org/) instance can aggregate and re-format the GeoServer data into human and machine-readable formats for creating public maps and data products. As an example: the OTN Members Portal uses GeoServer to visualize project data, and the [R package `otndo`](https://otndo.obrien.page) uses the existence of a GeoServer with station histories to produce data summaries for individual researchers about the places and times their tags were detected outside their own arrays.
3030

3131

3232
## Installation

_episodes/13_Database fix notebooks.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Some troubleshooting tips can be found in the `ipython Nodebooks` installation i
8989
## Gitlab KDBX integration
9090
An exciting feature of the Database Fix Notebooks is that if you add a Gitlab token to your kdbx file, the notebook will automatically comment the output from the notebook directly into the specified Gitlab issue. Otherwise, you will have to copy and paste the displayed results manualyl into the comments (as directed by the notebook).
9191

92-
To integrate the Gitlab token into your kdbx file, please use the instructions found at the bottom of the [AUTH - Create and Update](https://gitlab.oceantrack.org/otn-partner-nodes/ipython-utilities/-/blob/master/AUTH%20-%20Create%20and%20Update.ipynb) notebook in ipython-utilities.
92+
To integrate the Gitlab token into your kdbx file, please use the instructions found at the bottom of the [AUTH - Create and Update](https://gitlab.oceantrack.org/otn-partner-nodes/ipython-utilities/-/blob/main/AUTH%20-%20Create%20and%20Update.ipynb) notebook in ipython-utilities.
9393

9494
## Issue Creation
9595

@@ -115,8 +115,8 @@ Here is the Issue checklist, for reference:
115115
{: .language-plaintext .example}
116116

117117
There are a few helpful explanation notebooks inside this suite of Database Fix tools. You should always start by accessing both of these in order to identify next steps.
118-
- [0. Home](https://gitlab.oceantrack.org/otn-partner-nodes/database-fix-notebooks/-/blob/master/0.%20Home.ipynb): This notebook will provide a brief explanation of what each notebook does, as well as helpful hints to show what is needed to run the notebook.
119-
- [0. Which notebook should I use](https://gitlab.oceantrack.org/otn-partner-nodes/database-fix-notebooks/-/blob/master/0.%20Which%20notebook%20should%20I%20use.ipynb): This notebook has a form which will help node managers determine which Database Fix Notebook is appropriate for their change. It shows a list of the types of metadata we offer (project, tag, deployment, and detection) and, based on the selection, shows a list of columns from the raw metadata sheets. Based on the raw metadata column selection, it will display a result of which notebook to use.
118+
- [0. Home](https://gitlab.oceantrack.org/otn-partner-nodes/database-fix-notebooks/-/blob/main/0.%20Home.ipynb): This notebook will provide a brief explanation of what each notebook does, as well as helpful hints to show what is needed to run the notebook.
119+
- [0. Which notebook should I use](https://gitlab.oceantrack.org/otn-partner-nodes/database-fix-notebooks/-/blob/main/0.%20Which%20notebook%20should%20I%20use.ipynb): This notebook has a form which will help node managers determine which Database Fix Notebook is appropriate for their change. It shows a list of the types of metadata we offer (project, tag, deployment, and detection) and, based on the selection, shows a list of columns from the raw metadata sheets. Based on the raw metadata column selection, it will display a result of which notebook to use.
120120

121121
## Spreadsheet Creation
122122

_episodes/14_The Push.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ During the Push process, any new detection matches that are made are noted in th
7676

7777
Using these fields, the `detections-create detection extracts` Nodebook can determine which extracts need to be created for each push.
7878

79-
**As of December 2024, please ensure you are on the `master` branch of ipython utilities before running this Nodebook**
79+
**As of December 2024, please ensure you are on the `main` branch of ipython utilities before running this Nodebook**
8080

8181
To switch branches in Git, please follow the instructions on this page [https://gitlab.oceantrack.org/otn-partner-nodes/ipython-utilities/-/wikis/updating-notebooks-after-bugfixes-and-new-features#changing-branches-of-ipython-utilities](https://gitlab.oceantrack.org/otn-partner-nodes/ipython-utilities/-/wikis/updating-notebooks-after-bugfixes-and-new-features#changing-branches-of-ipython-utilities)
8282

_episodes/16_feature_requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,6 @@ mamba env update -n root -f environment.yml
119119
~~~
120120
{: .language-bash}
121121

122-
You will then be able to test the new code. When you are finished, follow the same steps to switch back to the `master` branch to continue your work. The `master` branch contains all the production-quality tools.
122+
You will then be able to test the new code. When you are finished, follow the same steps to switch back to the `main` branch to continue your work. The `main` branch contains all the production-quality tools.
123123

124124
{% include links.md %}

0 commit comments

Comments
 (0)