Giter Club home page Giter Club logo

mbon-docs's Introduction

mbon-docs

Guidance for Marine Biodiversity Observation Network (MBON) Data and File Formatting.

Contributing to the documentation

See CONTRIBUTING.

Deploying site locally

Requirements:

  • bundle
  • Jekyll

See IOOS How To: Local Development with Jekyll.

Clone this repository:

git clone https://github.com/ioos/mbon-docs.git

To build the site, in the mbon-docs/ directory run:

bundle exec jekyll serve --config _config.yml --watch --verbose --incremental

This will deploy a website at: http://127.0.0.1:4000/mbon-docs/

Make edits to the appropriate markdown files in _docs/.

If changing headers and menus, stop the running server by entering ctrl-c in the terminal. Then run:

bundle exec jekyll clean

Then build the site again.

bundle exec jekyll serve --config _config.yml --watch --verbose --incremental

And review at http://127.0.0.1:4000/mbon-docs/

mbon-docs's People

Contributors

abirger avatar albenson-usgs avatar gilltron avatar mathewbiddle avatar mwengren avatar srstsavage avatar staceybuckelew avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

mbon-docs's Issues

Recommendations for dataset title in EML records

We have a section for guidance on titles for dataset metadata. Should we include a template for US MBON dataset titles?

Here's a thought on what a template title could look like:

[observations] collected by [observation method] and distributed through [MBON Project] from [start date] to [end date] in the [marine region].

For example,

Zooplankton occurrences collected by bottle samples and distributed through the Gulf of Maine Marine Biodiversity Observation Network from 2004 to 2007 in the Gulf of Maine.

See https://ioos.github.io/mbon-docs/metadata-eml.html#eml-metadata

Build a quick start guide for MBON project data management activities

The quick start guide should include:

  • Register the dataset in the MBON dataset registration form. https://forms.gle/2meikdcMgYY6nMmG6
  • Add a polygon and descriptive metadata about the observations that were collected to https://bioeco.goosocean.org/
  • identification of what data goes where:
    • tabular data
      • raw data - RA ERDDAP
      • occurrence data - OBIS-USA
    • eDNA
      • raw sequences - NCBI
      • processed tabular data - RA ERDDAP
      • occurrence data - OBIS-USA
    • animal tracking
      • satellite telemetry - ATN
      • acoustic tracking - OTN/OTN node
    • passive acoustic
      • raw/processed audio files - NCEI
      • occurrence data - OBIS-USA
  • Identification of visualization platform
    • MBON Data Portal
    • ATN Portal
    • NCEI Passive Acoustic Portal
    • Infographics
    • etc...

Include information about persistent identifiers

The new OSTP PARR memo puts an emphasis on digital persistent identifiers. While we don't have to do anything about it yet, we should be thinking about persistent identifiers anyways.

I propose that this documentation should include information/guidance on US MBON's approach to the following categories of digital persistent identifiers:

  • Data (DOI through repositories (eg. NCEI, OBIS/GBIF/USGS??)
  • Person (ORCiD)
  • Institution (ROR, ORCiD, OceanExpert (although I don't think that's appropriate as a persistent identifier))

We should include information about:

  1. Why we need them
  2. How to get them
  3. How they get used

update (sidebar) ToC & assess page breakout

I want to take a look at the site again with the updated ToC before trying to break out into multiple pages. Here is the note I took on this today though:

page should broken into more targeted to a user-stories.
currently is big page with a lot of info for different purposes.

  • data file standards
  • MBON portal

Show the value of standardizing and sharing to OBIS

Statement: There have been some conversations about how US MBON can build an integrated product with all the data being collected.

Requirements: IMO, product should be built on data that have been standardized and shared to OBIS.

Problem: What should an integrated product be? The minimum data shared with OBIS are occurrences of a species at a location and time. Can we do something with that? Are there additional standardized data available we can integrate to make something?

My thoughts:

  • Out of all the datasets mobilized to OBIS from MBON projects (https://obis.org/institute/23070), I wonder how much and what type of additional data are available?
  • Once we know that, can we make a useful product from the occurrences and those additional measures?
  • Finally, from this exercise, develop guidance to other projects on what additional data to standardize in DwC and share?

I think this notebook will help as a start:

Imagery data management refs

Update how-to metadata guide for US MBON associatedParty

As discussed during the 12/13 MBON DMAC WG meeting, we will be adding "US MBON" as the organizationName for an additional associatedParty.

The associatedParty should be the person who worked with Abby to align the data to DarwinCore. You can find information about the associatedParty in this eml documentation: https://eml.ecoinformatics.org/schema/eml-resource_xsd.html#ResourceGroup_associatedParty

The role can be Processor but that might not always be the case (?). We don't have a clear source for the roles, but the following ticket should help us identify where the source is:

Finally, I have started a conversation with OceanExpert on creating an institution with the following information:

Name: United States Marine Biodiversity Observation Network
Acronym: US MBON
Address: 1315 East-West Highway, Silver Spring MD 20910
Website: https://ioos.noaa.gov/project/mbon/

Create a flow chart for passive acoustic monitoring data

Initial attempt at visualizing what is documented at https://www.ncei.noaa.gov/products/passive-acoustic-data#tab-3561

%%{
  init: {
    'theme': 'base',
    'themeVariables': {
      'primaryColor': '#007396',
      'primaryTextColor': '#fff',
      'primaryBorderColor': '#003087',
      'lineColor': '#003087',
      'secondaryColor': '#007396',
      'tertiaryColor': '#CCD1D1'
    },
   'flowchart': { 'curve': 'basis' }
  }
}%%

flowchart TD

A["hydrophone"] 

B{{"PassivePacker"}}

C{{"Darwin Core
Alignment"}}

D[("NCEI")]

E[("IPT
OBIS-USA")]

F[/"MBON 
Data Portal"\]

G([OBIS])

H([GBIF])

P[(IOOS RA ERDDAP)]

I(["IOOS Data Catalog
(data.ioos.us)"])

J([NOAA OneStop])

K([data.gov])

L(["Commerce
Data Hub"])

M[/"IOC-UNESCO Harmful Algae Information System"\]

N[/"Infographics"\]

%% O["GitHub /
%% protocols.io"]


A -- Species Detections --> C
A --raw audio files & 1-min hybrid millidecade bands --> B
B --> D
%% A -- Protocols --> O
C --> E
E --> D
%% O .-> E
E --> G
E --> H

%% NOAA STUFF
%% A -- Environmental Observations --> D
A -- non-acoustic data --> P
P --> I
P -- raw --> D
P -- occurrence --> C
I --> J
I --> K
I --> L
D --> J
D --> K
D --> L

G .-> Q
H .-> Q
F .-> Q
D .-> Q
J .-> Q
K .-> Q
L .-> Q

subgraph Q[Example Products]
M
N
F
end

click C "https://doi.org/10.35035/doc-vf1a-nr22" "GBIF eDNA Manual" _blank
click D "https://www.ncei.noaa.gov" "NCEI" _blank
click F "https://mbon.ioos.us" "MBON" _blank
click G "https://obis.org" "OBIS" _blank
click H "https://gbif.org" "GBIF" _blank
%%click I "https://data.ioos.us" "IOOS Catalog" _blank
%%click J "https://data.noaa.gov/onestop/" "NOAA OneStop" _blank
%%click K "https://data.gov" "data.gov" _blank

non-acoustic data is essentially anything measured in concert with the passive acoustic hydrophone. For example, abiotic measurements from sensors attached to the same platform, biotic observations nearby (camera trap), etc.

Recommended data license for MBON affiliated datasets mobilized to OBIS-USA

We should provide a recommendation for which license to select.

Highly recommend CC0 1.0 see http://creativecommons.org/about/cc0

With this license the publisher has waived all rights to these data ,to the extent possible under law, and has dedicated them to the public domain. Users may copy, modify, distribute and use the work, including for commercial purposes, without restriction.

OBIS Manual reference https://manual.obis.org/policy.html#data-sharing-agreement

cc @albenson-usgs @sformel-usgs

change title of site

This site is documenting how to contribute to the MBON data portal, so we should update the title to clearly state that.

Right now it's a little confusing having this help site for the MBON portal and this MBON Portal documentation site.

If we can merge the two together, that would be great!

I think the sections using the MBON portal, adding data to the map view, and how biodiversity products are created should be in the help site for the MBON portal as they are documenting specifics about the portal.

The site in this repository should be dedicated to providing documentation to the MBON projects on how to properly manage their biodiversity data. Not necessarily specific to the MBON portal.

In short, let's change the title so it's clear what each page is documenting. Then, lets look at merging the documentation.

identify a set of keywords for MBON projects to include in metadata

Various data systems that we are using require different flavors of metadata. One consistency between them is they all allow for some "free text" strings of keywords.

It has been mentioned in multiple venues that it would be beneficial to have a set list of identified keywords for the MBON projects to include in metadata records.

We should compile a list of those terms and guidelines for what keywords should be included.

Thinking terms like:

  • US MBON
  • MBON
  • affiliated Regional Association
  • IOOS
  • affiliated institution/university

additions to file format lists?

I have a few thoughts/opinions regarding the data file formats list. In no particular order:

  1. change "containers" to "file archives"
  2. can we add notes on compression to list of zip/gzip/tar?
    • especially for .tar, .tar.gz and .tar.bz2 are common and good practice
  3. "databases" seems too generic.
  4. what about .json and .sql for databases?
  5. metadata file formats should be mentioned here?
  6. what about notes for overall directory structure for "containers"("file archives")?
    • README file recommendation?
  7. "text" section should not include .xml and should include .txt, .md, (maybe) .rtf?
  8. what about "spreadsheets"? I would like to see an explicit recommendation to use an open format instead of proprietary .xlsx (eg .odf)
  9. "still images" should include a vector format (.svg)
  10. "still images" might include a multi-layer composited image format (.xcf?)

Add eDNA guidance

  • submit sequences to NCBI
  • submit occurrences to OBIS

Get insight from Diana's presentation.

Add details on OBIS-USA IPT archival to NCEI

MBON Colleagues,

I am very happy to announce that all datasets published through the OBIS-USA IPT are now archived at NCEI and will be archived quarterly going forward. This means when you publish data through OBIS-USA it will automatically be archived at NCEI....

Warmly,
Abby

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.