From 9aa96813c06b41b9cb064bd722d90ed21d90dabf Mon Sep 17 00:00:00 2001 From: Akshay Mestry Date: Sun, 1 Sep 2024 18:40:07 -0500 Subject: [PATCH 1/4] build(branching scheme): add new publishing configs Signed-off-by: Akshay Mestry --- .github/workflows/publish-dev-pages.yaml | 96 +++++++++++++++++++ .github/workflows/publish-feature-pages.yaml | 77 +++++++++++++++ ...ish-pages.yaml => publish-main-pages.yaml} | 30 +++--- 3 files changed, 186 insertions(+), 17 deletions(-) create mode 100644 .github/workflows/publish-dev-pages.yaml create mode 100644 .github/workflows/publish-feature-pages.yaml rename .github/workflows/{publish-pages.yaml => publish-main-pages.yaml} (85%) diff --git a/.github/workflows/publish-dev-pages.yaml b/.github/workflows/publish-dev-pages.yaml new file mode 100644 index 0000000..4d21bb4 --- /dev/null +++ b/.github/workflows/publish-dev-pages.yaml @@ -0,0 +1,96 @@ +# TOPST SCHOOL's GitHub Pages Dev Branch Publishing Workflow +# ========================================================== +# +# Author: Akshay Mestry +# Created on: Sunday, September 01 2024 +# Last updated on: Sunday, September 01 2024 + +# Workflow name displayed in TOPST SCHOOL's "Actions" tab. +name: DEV | Build and Deploy Documents + +# A workflow with the following "on" value will run when a "push" is made +# to the "dev" branch in the workflow's repository. For example, the "push" +# event has a branches filter that causes this workflow to run only when +# a push to a branch that matches the branches filter occurs, in this +# case, the "dev" branch. +on: + push: + branches: + - dev + +# We're using permissions to modify the default permissions granted to +# the ``GITHUB_TOKEN``, adding or removing access as required, so that we +# only allow the minimum required access. +permissions: + contents: write # Only write permissions to the repository contents are needed for deployment. + +# A map of variables that are available to the steps of all jobs in the workflow. +env: + OUTPUT_DIR: docs/build/ # Directory where Sphinx will output the built HTML files. + SOURCE_DIR: docs/source/ # Directory containing the Sphinx source files (rST or MD). + PUBLISH_BRANCH: gh-pages # Branch where the static site will be published. + PY_BUILD: 3.12.1 # Python version to be used for building the documentation. + +# We're using concurrency to ensure that only a single job or workflow +# using the same concurrency group will run at a time. +concurrency: + group: ${{ github.ref }} # Groups by branch, so jobs in the same branch won't overlap. + cancel-in-progress: true # Cancels any currently running jobs in the same group if a new one starts. + +# A workflow run is made up of one or more jobs, which run in parallel by default. +# The ``ubuntu-latest`` label currently uses the Ubuntu 22.04 runner image. +jobs: + build: + runs-on: ubuntu-latest # Runs the job on the latest available Ubuntu runner. + steps: + # Step 1: Check out the code from the repository to the runner. + - name: Checkout TOPST SCHOOL Code (Dev) + uses: actions/checkout@v4 # Checks out the repository code into the runner for the workflow to use. + with: + fetch-depth: 1 # Fetch only the latest commit for faster checkouts. + + # Step 2: Set up the specified Python version and cache pip dependencies for faster builds. + - name: Set Up Python ${{ env.PY_BUILD }} + uses: actions/setup-python@v5 + with: + python-version: ${{ env.PY_BUILD }} # Sets up the Python version specified in the environment variables. + cache: 'pip' # Caches pip dependencies to speed up subsequent builds. + + # Step 3: Install the project's Python dependencies. + - name: Install Python Dependencies + run: | + echo "Installing Coeus..." + python -m pip install --upgrade pip + pip install -U git+https://github.com/xames3/coeus-sphinx-theme.git#egg=coeus-sphinx-theme + + # Step 4: Build the Sphinx documentation into HTML format. + - name: Build Sphinx Documentation + # -E: Rebuild all files, not just those that have changed. + # -W: Treat warnings as errors. + # -a: Write all output files (default only writes new and changed files). + # -q: Run in quiet mode, with minimal output. + run: | + echo "Building Sphinx documentation..." + sphinx-build -EWaq -b html ${{ env.SOURCE_DIR }} ${{ env.OUTPUT_DIR }} + + # Step 5: Deploy the built HTML files to the specified branch (GitHub Pages). + - name: DEV | Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v4 + if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} + with: + github_token: ${{ secrets.GITHUB_TOKEN }} # Deploys to the gh-pages branch. + publish_branch: ${{ env.PUBLISH_BRANCH }} # Uses the GitHub token for authentication. + publish_dir: ${{ env.OUTPUT_DIR }} # Directory to publish (the output of the Sphinx build). + force_orphan: false # Do not force an orphan commit, preserving commit history. + enable_jekyll: false # Disables Jekyll processing on GitHub Pages, which is unnecessary for Sphinx-generated HTML. + user_email: "github-actions[bot]@users.noreply.github.com" # Email to associate with the commit. + user_name: "github-actions[bot]" # Name to associate with the commit. + full_commit_message: ${{ github.event.head_commit.message }} # Use the commit message from the push event. + + # Step 6: Provide response after deployment. + - name: Notify Success + if: success() + run: echo "✅ Documentation successfully built and deployed to GitHub Pages (Dev)." + - name: Notify Failure + if: failure() + run: echo "❌ Failed to build or deploy the documentation from the dev branch. Please check the logs." diff --git a/.github/workflows/publish-feature-pages.yaml b/.github/workflows/publish-feature-pages.yaml new file mode 100644 index 0000000..46212f0 --- /dev/null +++ b/.github/workflows/publish-feature-pages.yaml @@ -0,0 +1,77 @@ +# TOPST SCHOOL's GitHub Pages Feature Branch Workflow +# =================================================== +# +# Author: Akshay Mestry +# Created on: Sunday, September 01 2024 +# Last updated on: Sunday, September 01 2024 + +# Workflow name displayed in TOPST SCHOOL's "Actions" tab. +name: FEAT | Build and Deploy Documents + +# A workflow with the following "on" value will run when a "push" is made +# to the "feature" branch or pull request is made to "dev" in the +# workflow's repository. For example, the "push" event has a branches filter +# that causes this workflow to run only when a push to a branch that +# matches the branches filter occurs, in this case, the "dev" branch. +on: + push: + branches: + - "feature/**" + pull_request: + branches: + - dev + +# We're using permissions to modify the default permissions granted to +# the ``GITHUB_TOKEN``, adding or removing access as required, so that we +# only allow the minimum required access. +permissions: + contents: write # Only write permissions to the repository contents are needed for deployment. + +# A map of variables that are available to the steps of all jobs in the workflow. +env: + OUTPUT_DIR: docs/build/ # Directory where Sphinx will output the built HTML files. + SOURCE_DIR: docs/source/ # Directory containing the Sphinx source files (rST or MD). + PUBLISH_BRANCH: gh-pages # Branch where the static site will be published. + PY_BUILD: 3.12.1 # Python version to be used for building the documentation. + +# We're using concurrency to ensure that only a single job or workflow +# using the same concurrency group will run at a time. +concurrency: + group: ${{ github.ref }} # Groups by branch, so jobs in the same branch won't overlap. + cancel-in-progress: true # Cancels any currently running jobs in the same group if a new one starts. + +# A workflow run is made up of one or more jobs, which run in parallel by default. +# The ``ubuntu-latest`` label currently uses the Ubuntu 22.04 runner image. +jobs: + build: + runs-on: ubuntu-latest # Runs the job on the latest available Ubuntu runner. + steps: + # Step 1: Check out the code from the repository to the runner. + - name: Checkout TOPST SCHOOL Code (Dev) + uses: actions/checkout@v4 # Checks out the repository code into the runner for the workflow to use. + with: + fetch-depth: 1 # Fetch only the latest commit for faster checkouts. + + # Step 2: Set up the specified Python version and cache pip dependencies for faster builds. + - name: Set Up Python ${{ env.PY_BUILD }} + uses: actions/setup-python@v5 + with: + python-version: ${{ env.PY_BUILD }} # Sets up the Python version specified in the environment variables. + cache: 'pip' # Caches pip dependencies to speed up subsequent builds. + + # Step 3: Install the project's Python dependencies. + - name: Install Python Dependencies + run: | + echo "Installing Coeus..." + python -m pip install --upgrade pip + pip install -U git+https://github.com/xames3/coeus-sphinx-theme.git#egg=coeus-sphinx-theme + + # Step 4: Build the Sphinx documentation into HTML format. + - name: Build Sphinx Documentation + # -E: Rebuild all files, not just those that have changed. + # -W: Treat warnings as errors. + # -a: Write all output files (default only writes new and changed files). + # -q: Run in quiet mode, with minimal output. + run: | + echo "Building Sphinx documentation..." + sphinx-build -EWaq -b html ${{ env.SOURCE_DIR }} ${{ env.OUTPUT_DIR }} diff --git a/.github/workflows/publish-pages.yaml b/.github/workflows/publish-main-pages.yaml similarity index 85% rename from .github/workflows/publish-pages.yaml rename to .github/workflows/publish-main-pages.yaml index 235afea..a46f354 100644 --- a/.github/workflows/publish-pages.yaml +++ b/.github/workflows/publish-main-pages.yaml @@ -1,26 +1,22 @@ -# TOPST SCHOOL's GitHub Pages Publishing Workflow -# =============================================== +# TOPST SCHOOL's GitHub Pages Main Branch Publishing Workflow +# =========================================================== # # Author: Akshay Mestry -# Created on: Friday, August 30 2024 +# Created on: Sunday, September 01 2024 # Last updated on: Sunday, September 01 2024 # Workflow name displayed in TOPST SCHOOL's "Actions" tab. -name: Build and Deploy TOPST SCHOOL Documentation +name: MAIN | Build and Deploy Documents -# A workflow with the following "on" value will run when a "push" and -# "pull_request" is made to the "main" branch in the workflow's repository. -# For example, the "push" event has a branches filter that causes this -# workflow to run only when a push to a branch that matches the branches -# filter occurs, in this case, the "main" branch. +# A workflow with the following "on" value will run when a "push" is made +# to the "main" branch in the workflow's repository. For example, the "push" +# event has a branches filter that causes this workflow to run only when +# a push to a branch that matches the branches filter occurs, in this +# case, the "main" branch. on: push: branches: - main - pull_request: - branches: - - main - workflow_dispatch: # Allows manual triggering of the workflow from the GitHub UI. # We're using permissions to modify the default permissions granted to # the ``GITHUB_TOKEN``, adding or removing access as required, so that we @@ -48,7 +44,7 @@ jobs: runs-on: ubuntu-latest # Runs the job on the latest available Ubuntu runner. steps: # Step 1: Check out the code from the repository to the runner. - - name: Checkout TOPST SCHOOL Code + - name: Checkout TOPST SCHOOL Code (Main) uses: actions/checkout@v4 # Checks out the repository code into the runner for the workflow to use. with: fetch-depth: 1 # Fetch only the latest commit for faster checkouts. @@ -78,7 +74,7 @@ jobs: sphinx-build -EWaq -b html ${{ env.SOURCE_DIR }} ${{ env.OUTPUT_DIR }} # Step 5: Deploy the built HTML files to the specified branch (GitHub Pages). - - name: Deploy TOPST SCHOOL Documentation to GitHub Pages + - name: MAIN | Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v4 if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} with: @@ -94,7 +90,7 @@ jobs: # Step 6: Provide response after deployment. - name: Notify Success if: success() - run: echo "✅ Documentation successfully built and deployed to GitHub Pages." + run: echo "✅ Documentation successfully built and deployed to GitHub Pages (Main)." - name: Notify Failure if: failure() - run: echo "❌ Failed to build or deploy the documentation. Please check the logs." + run: echo "❌ Failed to build or deploy the documentation from the main branch. Please check the logs." From 49daa4d8180b394d78ac9620695c86e0ebf117a2 Mon Sep 17 00:00:00 2001 From: Akshay Mestry Date: Sun, 1 Sep 2024 18:41:53 -0500 Subject: [PATCH 2/4] chore(urls): remove unicode replacement for dash Signed-off-by: Akshay Mestry --- docs/source/_static/urls.txt | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/source/_static/urls.txt b/docs/source/_static/urls.txt index 3c37088..0e04991 100644 --- a/docs/source/_static/urls.txt +++ b/docs/source/_static/urls.txt @@ -1,9 +1,6 @@ .. role:: raw-html(raw) :format: html -.. |---| unicode:: U+02014 .. em dash - :trim: - .. |html-br| replace:: :raw-html:`
` .. |html-dash| replace:: :raw-html:`—` .. |html-tab| replace:: :raw-html:` ` From 6ace51673466fadc49572da032c071d62cd948ef Mon Sep 17 00:00:00 2001 From: Akshay Mestry Date: Sun, 1 Sep 2024 18:43:09 -0500 Subject: [PATCH 3/4] feat(getting started): add new guides as introduction Signed-off-by: Akshay Mestry --- .../source/_documentation/getting-started.rst | 170 +++++++++++++ .../open-science-essentials.rst | 233 ++++++++++++++++++ docs/source/index.rst | 19 +- 3 files changed, 417 insertions(+), 5 deletions(-) create mode 100644 docs/source/_documentation/getting-started.rst create mode 100644 docs/source/_documentation/open-science-essentials.rst diff --git a/docs/source/_documentation/getting-started.rst b/docs/source/_documentation/getting-started.rst new file mode 100644 index 0000000..cfbb3cb --- /dev/null +++ b/docs/source/_documentation/getting-started.rst @@ -0,0 +1,170 @@ +.. Author: Akshay Mestry +.. Created on: Saturday, September 01 2024 +.. Last updated on: Saturday, September 01 2024 + +=============================================================================== +Getting Started +=============================================================================== + +.. title-hero:: + :article: Guide + :icon: fa-solid fa-compass + :gradient: linear-gradient(-90deg, #f9dfef, #fdf5fa) + :summary: + SCHOOL program is a key initiative by NASA aimed at advancing Open + Science principles, which emphasize transparency, collaboration, and + inclusivity in research. + +.. tags:: getting-started + +.. contributors:: + + - Dhruvil Prajapati + - dprajapati@my.nl.edu + - https://github.com/dhru-repository/ + + - America Munoz + - amunoz8@my.nl.edu + - https://github.com/america-m/ + +We're delighted to welcome you to the **Science Core Heuristics for Open +Science Outcomes in Learning** (:term:`SCHOOL`) program, a pivotal part of +NASA's commitment to fostering a culture of `Open Science`_. Open Science is +more than just a concept; it's a transformative approach to research and +knowledge sharing that prioritizes transparency, collaboration, and +inclusivity. Whether you're a student, a seasoned researcher, or someone +passionate about science, you are about to embark on a journey that will +empower you to contribute to a global movement dedicated to making scientific +research more accessible and impactful. + +------------------------------------------------------------------------------- +What is the TOPST SCHOOL Program? +------------------------------------------------------------------------------- + +The TOPST SCHOOL program is designed to introduce you to the principles and +practices of Open Science in a structured and engaging way. As a part of +:term:`TOPS` Training initiative, :term:`SCHOOL` aims to build an inclusive +and diverse community of learners who are equipped with the tools and +knowledge needed to participate in and contribute to the world of open science. + +At its core, the :term:`SCHOOL` program provides a series of learning modules +that cover a wide array of critical topics, ranging from environmental justice +to climate change and from Earth Science applications to the :term:`FAIR` [#]_ +data principles. Each module is crafted to be interactive, interdisciplinary, +and inclusive, ensuring that no matter your background or experience level, you +can engage fully with the content and apply what you learn in meaningful ways. + +`Open Science`_ is about breaking down barriers and making scientific data and +research accessible to everyone. The :term:`SCHOOL` program not only teaches +you how to access and analyze open data but also encourages you to think +critically about the impact of your work and how it can contribute to broader +societal goals. By the end of the program, you'll have a solid understanding +of Open Science principles and the skills necessary to implement them in your +own work. + +------------------------------------------------------------------------------- +How to Get Started +------------------------------------------------------------------------------- + +Before diving into the specific modules, it's essential to build a strong +foundation in the basic principles of Open Science. This understanding will +not only help you navigate the :term:`SCHOOL` program more effectively but also +provide you with the context needed to appreciate the broader significance of +what you're learning. + +Introduction to Open Science +=============================================================================== + +Open Science is a movement that seeks to make scientific research more +accessible, transparent, and collaborative. It challenges the traditional +models of research that often limit access to data, findings, and publications +to a select few. Open Science advocates for the sharing of all aspects of the +research process, from raw data and methods to final publications, in a way +that is accessible to everyone. By embracing Open Science, researchers can +increase the visibility, reproducibility, and impact of their work. This +introduction will give you a comprehensive overview of the history, +principles, and current practices in Open Science. + +Why Open Science Matters? +=============================================================================== + +The significance of Open Science cannot be overstated. In a world where +scientific challenges |html-dash| like climate change, pandemics, and +environmental degradation |html-dash| are increasingly complex and +interconnected, the need for open and collaborative research is more critical +than ever. Open Science enables researchers to share their data and methods +freely, allowing others to build upon their work, avoid duplication of effort, +and accelerate the pace of discovery. This resource will explain why Open +Science is essential for advancing knowledge, fostering innovation, and +addressing global challenges in an inclusive and equitable way. + +------------------------------------------------------------------------------- +Explore the Curriculum +------------------------------------------------------------------------------- + +The :term:`SCHOOL` program offers a carefully curated selection of learning +modules that cater to a wide range of interests and expertise levels. These +modules are not just educational |html-dash| they are designed to be +transformative, equipping you with the knowledge and skills to apply Open +Science principles in real-world contexts. + +.. tip:: + + Before diving into the :term:`SCHOOL` modules, ensure that you have all the + necessary accounts and tools set up. This will streamline your experience + and allow you to fully engage with the course content. + +Browse Modules +=============================================================================== + +Each module in the SCHOOL program is centered around a thematic area of +critical importance to both science and society. For example, our modules on +Water Systems delve into the science behind water cycles, the impact of +climate change on water resources, and how open data can be used to manage and +protect these vital systems. The Health and Air Quality module explores the +intersection of environmental science and public health, showing you how to +access and analyze data related to air pollution and its effects on human +health. Similarly, modules on Environmental Justice, Natural Disasters, +Climate Change, Agriculture, and Wildfires offer deep dives into these +critical issues, integrating the :term:`FAIR` data principles to ensure that +the data you work with is **Findable**, **Accessible**, **Interoperable**, and +**Reusable**. + +Each module includes a variety of interactive elements |html-dash| such as case +studies, real-world data analysis exercises, and discussions |html-dash| that +are designed to engage you and help you apply what you learn. The +interdisciplinary nature of the curriculum means that you will gain insights +from multiple scientific perspectives, enhancing your overall understanding of +the subject matter. + +.. attention:: + + Pay attention to the specific requirements for each module. Some may + require additional software or data access, so it's important to review the + pre-requisites before starting. + +------------------------------------------------------------------------------- +Engage with the Community +------------------------------------------------------------------------------- + +Open Science is fundamentally about collaboration and community. While the +:term:`SCHOOL` program offers a wealth of resources for individual learning, we +strongly encourage you to engage with your peers, share your insights, and +learn from others. Building connections with fellow learners and experts in +the field can greatly enrich your learning experience and open up new +opportunities for collaboration. + +------------------------------------------------------------------------------- +Your Next Steps +------------------------------------------------------------------------------- + +Now that you know the basics, it's time to take the first step. Whether you're +starting with an introductory module or jumping straight into a topic that +piques your interest, remember that you're part of a supportive, collaborative +community. We're excited to see where this journey takes you and how you'll +contribute to the world of Open Science. + +.. rubric:: Reference + :heading-level: 2 + +.. [#] `FAIR Principles `_. diff --git a/docs/source/_documentation/open-science-essentials.rst b/docs/source/_documentation/open-science-essentials.rst new file mode 100644 index 0000000..90d92e5 --- /dev/null +++ b/docs/source/_documentation/open-science-essentials.rst @@ -0,0 +1,233 @@ +.. Author: Akshay Mestry +.. Created on: Saturday, September 01 2024 +.. Last updated on: Saturday, September 01 2024 + +=============================================================================== +Open Science Essentials +=============================================================================== + +.. title-hero:: + :article: Guide + :icon: fa-solid fa-screwdriver-wrench fa-flip-horizontal + :gradient: linear-gradient(135deg, #ffe6d9, #fff8f3) + :summary: + SCHOOL program is a key initiative by NASA aimed at advancing Open + Science principles, which emphasize transparency, collaboration, and + inclusivity in research. + +.. tags:: getting-started + +.. contributors:: + + - Dhruvil Prajapati + - dprajapati@my.nl.edu + - https://github.com/dhru-repository/ + + - America Munoz + - amunoz8@my.nl.edu + - https://github.com/america-m/ + +------------------------------------------------------------------------------- +Overview +------------------------------------------------------------------------------- + +:term:`NASA` is at the forefront of a transformative movement in the scientific +community |html-dash| one that is rooted in the principles of openness, +collaboration, and inclusivity. Over the next decade, NASA is making a +long-term commitment to fostering an inclusive Open Science community, where +the sharing of software, data, and knowledge happens as early as possible in +the scientific process. This initiative, known as `Open Science`_ at NASA, +represents a cultural shift that goes beyond just technological advancements. + +Open Source Science: A Commitment to Transparency +=============================================================================== + +Open-Source Science is NASA's pledge to make the entire scientific process +transparent, inclusive, accessible, and reproducible. This involves the open +sharing of all aspects of research, including software, data, algorithms, +papers, documents, and ancillary information, from the very beginning. By +doing so, NASA is not just advancing technology but is also pushing for a +cultural transformation in the way science is conducted. + +The principles of open-source science are built on the idea that publicly +funded research should be accessible to everyone. This openness allows for +greater collaboration, reduces duplication of efforts, and broadens the user +community. It also ensures that scientific research is reproducible, thereby +increasing the reliability and impact of scientific findings. + +.. figure:: https://science.nasa.gov/wp-content/uploads/2021/10/ + ksc-20210114-ilw02-0030large.jpg?w=2048&format=webp + :class: height-450 object-fit-center + + Researcher carefully preparing samples in a laboratory setting, embodying + the spirit of Open Science. By sharing data transparently and including + diverse scientists in the process, NASA's open-source science approach + accelerates groundbreaking discoveries and fosters a more inclusive and + collaborative scientific community. [#nasa_open_science_reference]_ + + +Transform to Open Science (TOPS) Initiative +=============================================================================== + +To help the scientific community and the public adopt Open Science practices, +NASA has launched the Transform to Open Science (TOPS) initiative [#]_. This +initiative aims to educate and empower researchers, academics, and the general +public by providing them with the tools and knowledge they need to implement +Open Science in their work. One of the key offerings of the TOPS initiative is +"`Open Science 101`_," a free online training course that provides a practical +understanding of Open Science principles. + +The Benefits of Open Science +=============================================================================== + +Open Science, when properly implemented, offers a multitude of benefits that +can revolutionize the way research is conducted and utilized. Below are four +key areas where Open Science makes a significant impact: + +.. figure:: https://science.nasa.gov/wp-content/uploads/2021/10/pia23275large. + jpg?w=2048&format=webp + :class: height-450 object-fit-top + + Researchers collaborate in fieldwork, studying geological formations in a + remote landscape. This scene reflects NASA's commitment to Open Science, + where teamwork, transparency, and shared knowledge drive progress. It + highlights how Open Science fosters inclusivity and collaboration, + accelerating discovery and ensuring that scientific advances are + accessible. [#nasa_open_science_reference]_ + + +.. dropdown:: Four key areas where Open Science makes a significant impact + + .. tab-set:: + + .. tab-item:: Accessibility + + - **Citizen Science Initiatives and Engagement:** Open Science + allows for greater participation from the public, enabling + citizen scientists to contribute to research efforts and engage + with scientific discoveries. + + - **Lifesaving Access to Medical and Scientific Information:** Open + Science ensures that critical medical and scientific information + is accessible to everyone, potentially saving lives by providing + timely and accurate data. + + - **Democratization of the Scientific Process:** By making research + accessible to all, Open Science democratizes the scientific + process, giving everyone chance to contribute to and benefit + from scientific advancements. + + - **Increased Earth Observation Accessibility:** Open Science + expands access to Earth observation data, allowing more people + to monitor and understan our planet. + + .. tab-item:: Efficiency & Innovation + + - **Cleaner, More Secure Code with More Contributors:** Open-source + science invites a broader community to contribute to and improve + scientific software, leading to cleaner, more secure code. + + - **Long-Term Maintenance Assistance:** The open-source model + encourages long-term maintenance and support from the community, + ensuring that tools and resources remain up-to-date and + functional. + + - **New Monetized Offices and Data Centers:** Open Science can + lead to the creation of new monetized opportunities, such as + data centers, that support and enhance scientific research. + + - **Transparent Research Spending:** Open Science promotes + transparency in research spending, making the allocation of funds + more efficient and accountable. + + .. tab-item:: Reproducibility + + - **Increased Transparency of Research Results:** Open Science + makes research results more transparent, allowing for easier + verification and replication of studies. + + - **Reliable Results Through Confirmation:** The open sharing of + data and methodologies enables other researchers to confirm + findings, leading to more reliable and robust scientific + outcomes. + + - **Reduced Pressure for "Exciting" Research:** By focusing on + reproducibility and transparency, Open Science reduces the + pressure to produce "exciting" results just to get published, + fostering a more honest and rigorous scientific process. + + - **More Robust Scientific Products:** Open Science enhances the + overall quality of scientific research, leading to more + trustworthy and impactful results. + + .. tab-item:: Diversity & Inclusion + + - **International Accessibility:** Open Science ensures that + scientific knowledge is accessible to researchers around the + world, regardless of their location or resources. + + - **Breaking Down Financial Barriers:** Open Science helps to + dismantle systemic financial barriers, allowing more people to + participate in and benefit from scientific research. + + - **Diversity Among Researchers:** By making science more + accessible, open science encourages greater diversity among + researchers, leading to a richer and more inclusive scientific + community. + + - **Equitable Distribution of Opportunity:** Open Science ensures + that opportunities for research and collaboration are + distributed more equitably, fostering a more inclusive and + diverse scientific environment. + +Through its Open Science initiative, :term:`NASA` is leading the charge toward +a more open, collaborative, and inclusive scientific community. By embracing +these principles, the scientific community can accelerate progress, enhance the +quality and reliability of research, and ensure that the benefits of +scientific discovery are shared by all. + +------------------------------------------------------------------------------- +What you'll need |badge-beta| +------------------------------------------------------------------------------- + +Before diving into the rich resources and collaborative projects that await +you, there are a few essential steps to get started. Creating the necessary +accounts will equip you with the tools you need to contribute to and benefit +from this global movement. Don't worry |html-dash| whether you're a seasoned +researcher or new to the field, this guide will walk you through each step +with ease. Let's get started! + +.. dropdown:: Accounts + + .. tab-set:: + + .. tab-item:: GitHub + + `GitHub`_ is a platform where millions of developers and + researchers collaborate on open-source projects. It's a key tool + in the Open Science toolkit, enabling you to share your code, + collaborate with others, and contribute to existing projects. + + .. image:: _assets/banners/github-landing-page.png + :class: rounded-image-15 + + GitHub isn't just a repository for code; it's a community. By + creating a GitHub account, you'll be joining a global network of + scientists, developers, and enthusiasts who are committed to making + science more transparent and collaborative. + + Don't have a GitHub account? `Create yours now `_ |chevron-right| + +.. rubric:: Reference + :heading-level: 2 + +.. [#nasa_open_science_reference] Image courtesy of + `NASA `_ + and `NASA/JPL-Caltech `_. + +.. [#] NASA Launches New `Open Science Curriculum + `_. + +.. _open science 101: http://openscience101.org diff --git a/docs/source/index.rst b/docs/source/index.rst index f94b210..84748f9 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -25,12 +25,12 @@ TOPST Science Core Heuristics for Open Science Outcomes in Learning **Science Core Heuristics for Open Science Outcomes in Learning** (`SCHOOL`_), is an integral part of |website-tops| Training initiative. Our mission is to cultivate a vibrant, inclusive culture of open science that welcomes everyone -|---| students, researchers, and curious minds alike |---| to +|html-dash| students, researchers, and curious minds alike |html-dash| to engage, learn, and contribute to the world of scientific discovery. The :term:`SCHOOL` curriculum is a thoughtfully designed program that offers five immersive, 2.5-hour learning modules. These sessions are more than just -lessons |---| they are interactive, interdisciplinary journeys through +lessons |html-dash| they are interactive, interdisciplinary journeys through some of the most critical themes of our time. Whether it's exploring the intricacies of **water systems**, **health** and **air quality**, **environmental justice**, **natural disasters**, **climate change**, @@ -50,7 +50,7 @@ In each module, you'll find a rich blend of lessons that are not only informative but also transformative. We dive deep into Earth Science Applications, offering real-world use cases that show you how to access and analyze vast data sources. These lessons are rooted in the principles of -:term:`FAIR` data management |---| ensuring that the scientific data you +:term:`FAIR` data management |html-dash| ensuring that the scientific data you work with is **Findable**, **Accessible**, **Interoperable**, and **Reusable**. By learning to navigate these open data science lifecycle workflows, you're not just gaining knowledge; you're acquiring the tools to @@ -76,7 +76,7 @@ believe that diversity enriches the learning experience, and our curriculum reflects this belief. By incorporating a variety of examples that transcend gender, cultural, and socioeconomic barriers, we ensure that every student feels represented and valued. Our content is delivered in multiple modes -|---| visual, textual, and interactive |---| so that everyone, +|html-dash| visual, textual, and interactive |html-dash| so that everyone, regardless of their background or prior experience, can engage fully and comfortably. @@ -84,7 +84,7 @@ comfortably. to go beyond passive listening. Whether you're reading, discussing, executing code, or writing, we want you to think critically about what you're doing. In our asynchronous learning environments, you won't just be watching a video; -you'll be asked to engage |---| look at an image, interact with your +you'll be asked to engage |html-dash| look at an image, interact with your surroundings, or draw on your past experiences. This hands-on, minds-on approach ensures that learning is both dynamic and deeply personal. @@ -133,6 +133,15 @@ resources and insights to enhance transparency and collaboration in research. Prepare to join a global movement dedicated to advancing accessible and impactful scientific research. +:doc:`Let's get started <_documentation/getting-started>` |chevron-right| + +.. toctree:: + :hidden: + :maxdepth: 1 + + _documentation/getting-started + _documentation/open-science-essentials + .. toctree:: :hidden: :maxdepth: 1 From 63d999ff77a4c08b647d34b523b9a7bddecb8965 Mon Sep 17 00:00:00 2001 From: Akshay Mestry Date: Sun, 1 Sep 2024 18:45:39 -0500 Subject: [PATCH 4/4] fix(typo): resolve branch name Signed-off-by: Akshay Mestry --- .github/workflows/publish-feature-pages.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish-feature-pages.yaml b/.github/workflows/publish-feature-pages.yaml index 46212f0..48dd17f 100644 --- a/.github/workflows/publish-feature-pages.yaml +++ b/.github/workflows/publish-feature-pages.yaml @@ -47,7 +47,7 @@ jobs: runs-on: ubuntu-latest # Runs the job on the latest available Ubuntu runner. steps: # Step 1: Check out the code from the repository to the runner. - - name: Checkout TOPST SCHOOL Code (Dev) + - name: Checkout TOPST SCHOOL Code (Feature) uses: actions/checkout@v4 # Checks out the repository code into the runner for the workflow to use. with: fetch-depth: 1 # Fetch only the latest commit for faster checkouts.