diff --git a/docs/CNAME b/docs/CNAME index 29daaf3..23ecc35 100644 --- a/docs/CNAME +++ b/docs/CNAME @@ -1 +1 @@ -opensarlab-docs.asf.alaska.edu \ No newline at end of file +OpenSARLab-docs.asf.alaska.edu \ No newline at end of file diff --git a/docs/dev-guides/conda_environments.md b/docs/dev-guides/conda_environments.md index 66ec1ec..f27cb9b 100644 --- a/docs/dev-guides/conda_environments.md +++ b/docs/dev-guides/conda_environments.md @@ -1,6 +1,6 @@ [Return to Developer Guide](../dev.md) -# There are a few options for creating conda environments in OpenSARlab. +# There are a few options for creating conda environments in OpenSARLab. Each option come with benefits and drawbacks. --- @@ -25,7 +25,7 @@ Each option come with benefits and drawbacks. - Environments are synced, not copied, so changes made by users will persist across server restarts ### Drawbacks -- Increases the time it takes to start an OpenSARlab server +- Increases the time it takes to start an OpenSARLab server - Syncing environments from the docker image to `$HOME/.local`, registering their kernels, and running any needed setup scripts all happens at server startup - Large environments may overrun the 20GB root volume mounted on each EC2 instance, requiring that larger, more expensive root volumes be used. - By storing the environment on both user volumes and EC2 node volumes, you effectively double pay for that storage. @@ -41,4 +41,4 @@ Each option come with benefits and drawbacks. ### Drawbacks - Users have to create their own conda environments - This requires some knowledge of conda and takes time. - - Note: There is an [ASF notebook repo](https://github.com/ASFOpenSARlab/opensarlab-envs) to aid users in building their own environments. \ No newline at end of file + - Note: There is an [ASF notebook repo](https://github.com/ASFOpenSARLab/OpenSARLab-envs) to aid users in building their own environments. \ No newline at end of file diff --git a/docs/dev-guides/deploy_OpenSARlab.md b/docs/dev-guides/deploy_OpenSARlab.md index 8ded7e3..3505a45 100644 --- a/docs/dev-guides/deploy_OpenSARlab.md +++ b/docs/dev-guides/deploy_OpenSARlab.md @@ -1,10 +1,10 @@ [Return to Developer Guide](../dev.md) -Deploy OpenSARlab to an AWS account +Deploy OpenSARLab to an AWS account ===================== -**A note about deployments:** A deployment of OpenSARlab refers to a standalone instance of OpenSARlab. -If you are setting up OpenSARlab for several classes and/or collaborative groups with disparate needs or funding sources, +**A note about deployments:** A deployment of OpenSARLab refers to a standalone instance of OpenSARLab. +If you are setting up OpenSARLab for several classes and/or collaborative groups with disparate needs or funding sources, it may be useful to give them each their own standalone deployment. This separates user group authentication, simplifies billing for each group, and allows for easy cleanup at the end of a project or class (just delete the deployment). In the following instructions, replace any occurrence of "`deployment_name`" with the deployment name you have chosen. @@ -15,7 +15,7 @@ generate part of the Cognito callback URL and CloudFormation stack names also fo Take AWS SES out of sandbox -------------------- -**The AWS Simple Email Service is used by OpenSARlab to send emails to users and administrators. These include +**The AWS Simple Email Service is used by OpenSARLab to send emails to users and administrators. These include authentication related notifications and storage lifecycle management messages.** While SES is in sandbox, you are limited to sending 1 email per second with no more than 200 in a 24 hour period, and they @@ -78,7 +78,7 @@ formatted calendar should work as well** Store your CA certificate -------------------- -**OpenSARlab will lack full functionality if not using https (SSL certification)** +**OpenSARLab will lack full functionality if not using https (SSL certification)** 1. Follow these [instructions](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) to import your CA certificate into the AWS Certificate Manager @@ -86,13 +86,13 @@ Prepare CodeCommit Repos -------------------- TODO Do this differently -**All the public OpenSARlab repos are in the [ASFOpenSARlab](https://github.com/ASFOpenSARlab) Github Org** +**All the public OpenSARLab repos are in the [ASFOpenSARLab](https://github.com/ASFOpenSARLab) Github Org** 1. Create a `deployment_name`-container CodeCommit repo in your AWS account 1. Create a `deployment_name`-cluster CodeCommit repo 1. Clone the `deployment_name`-container and `deployment_name`-cluster repos to your local computer using ssh 1. cd into your local `deployment_name`-container repo - 1. add ASFOpenSARlab/opensarlab-container as a remote on your local `deployment_name`-container repo + 1. add ASFOpenSARLab/opensarlab-container as a remote on your local `deployment_name`-container repo 1. `git remote add github https://github.com/ASFOpenSARlab/opensarlab-container.git` 1. Pull the remote opensarlab-container repo into your local `deployment_name`-container repo 1. `git pull github main` diff --git a/docs/dev-guides/mintpy_conda.md b/docs/dev-guides/mintpy_conda.md index 3a9a433..be23e03 100644 --- a/docs/dev-guides/mintpy_conda.md +++ b/docs/dev-guides/mintpy_conda.md @@ -1,8 +1,8 @@ -# Build latest mintpy and push to custom OpenSARlab conda channel +# Build latest mintpy and push to custom OpenSARLab conda channel Sometimes the latest version of MintPy is desired within a notebook but the official release is not current. These instructions will show how to build MintPy and push to a custom conda channel. -_This assumes that the user has an Anaconda.org account and that this account is attached to a `opensarlab` conda channel. Instructions on how to do this are not provided here._ +_This assumes that the user has an Anaconda.org account and that this account is attached to a `OpenSARLab` conda channel. Instructions on how to do this are not provided here._ A. Create working directory @@ -77,10 +77,10 @@ cd .. I. After a successful build, check for artifacts in `mintpy-feedstock/build_artifacts/` -J. Push changes to OpenSARlab conda channel. +J. Push changes to OpenSARLab conda channel. ```bash -# Login to individual account where you are an owner of OpenSARlab org +# Login to individual account where you are an owner of OpenSARLab org anaconda login # Upload artifacts diff --git a/docs/dev-guides/notifications.md b/docs/dev-guides/notifications.md index b8a6178..325c3e5 100644 --- a/docs/dev-guides/notifications.md +++ b/docs/dev-guides/notifications.md @@ -1,6 +1,6 @@ [Return to Developer Guide](../dev.md) -# Create OpenSARlab Notifications +# Create OpenSARLab Notifications 1. Create a new event in your notification calendar 1. The event title corresponds to the notification title diff --git a/docs/dev-guides/system_diagram.md b/docs/dev-guides/system_diagram.md index 9dd7dab..707e4a7 100644 --- a/docs/dev-guides/system_diagram.md +++ b/docs/dev-guides/system_diagram.md @@ -1,5 +1,5 @@ [Return to Table of Contents](../dev.md) -# OpenSARlab System Diagram +# OpenSARLab System Diagram -![OpenSARlab system diagram June 2021](../assets/system_diagrams/OpenSARlab_system_diagram_June_2021.png) \ No newline at end of file +![OpenSARLab system diagram June 2021](../assets/system_diagrams/OpenSARLab_system_diagram_June_2021.png) \ No newline at end of file diff --git a/docs/dev.md b/docs/dev.md index dc68c9d..3c599b3 100644 --- a/docs/dev.md +++ b/docs/dev.md @@ -1,6 +1,6 @@ -1. [System Diagram](assets/system_diagrams/OpenSARlab_system_diagram_June_2021.png) -1. [Deploy OpenSARlab to AWS](dev-guides/deploy_OpenSARlab.md) +1. [System Diagram](assets/system_diagrams/OpenSARLab_system_diagram_June_2021.png) +1. [Deploy OpenSARLab to AWS](dev-guides/deploy_OpenSARLab.md) 1. [Conda Environment Options](dev-guides/conda_environments.md) -1. [OpenSARlab Notifications](dev-guides/notifications.md) +1. [OpenSARLab Notifications](dev-guides/notifications.md) 1. [Troubleshooting](dev-guides/troubleshooting.md) 1. [Custom Mintpy Conda Build Instructions](dev-guides/mintpy_conda.md) diff --git a/docs/index.md b/docs/index.md index 91cd187..e25222f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,19 +1,19 @@ -# Welcome to OpenSARlab +# Welcome to OpenSARLab -## What is OpenSARlab? +## What is OpenSARLab? -OpenSARlab is a service providing users persistent, cloud-based, customizable computing environments. Groups of scientists and students have access to identical environments, containing the same software, running on the same hardware. It operates in the cloud, which means anyone with a moderately reliable internet connection can access their development environment. OpenSARlab sits alongside ASF's data archives in AWS, allowing for low latency transfer of large data products. +OpenSARLab is a service providing users persistent, cloud-based, customizable computing environments. Groups of scientists and students have access to identical environments, containing the same software, running on the same hardware. It operates in the cloud, which means anyone with a moderately reliable internet connection can access their development environment. OpenSARLab sits alongside ASF's data archives in AWS, allowing for low latency transfer of large data products. -OpenSARlab is a deployable service that creates an autoscaling Kubernetes cluster in Amazon AWS, running JupyterHub. Users have access to customizable environments running JupyterLab via authenticated accounts with persistent storage. +OpenSARLab is a deployable service that creates an autoscaling Kubernetes cluster in Amazon AWS, running JupyterHub. Users have access to customizable environments running JupyterLab via authenticated accounts with persistent storage. -While OpenSARlab was designed with SAR data science in mind, it is not limited to this field. Any group +While OpenSARLab was designed with SAR data science in mind, it is not limited to this field. Any group development scenario involving large datasets and/or the need for complicated development environments -can benefit from working in an OpenSARlab deployment. +can benefit from working in an OpenSARLab deployment. [Sign in or create an account to try OpenSARLab](https://opensarlab.asf.alaska.edu/hub/login) -## How will OpenSARlab benefit my work as a SAR scientist? -OpenSARlab addresses the following issues that often arise when developing SAR data science techniques, especially in +## How will OpenSARLab benefit my work as a SAR scientist? +OpenSARLab addresses the following issues that often arise when developing SAR data science techniques, especially in a collaborative setting: * Most SAR analysis algorithms require the installation of many interdependent Python science packages @@ -22,15 +22,15 @@ OpenSARlab addresses the following issues that often arise when developing SAR d * SAR data products are often quite large, which leads to slow, expensive data transfers * SAR scientists with limited resources may lack access to the hardware required for analysis -## How will OpenSARlab benefit the class or training I am planning? -OpenSARlab alleviates some of the pitfalls commonly encountered when teaching software development and data science in any field: +## How will OpenSARLab benefit the class or training I am planning? +OpenSARLab alleviates some of the pitfalls commonly encountered when teaching software development and data science in any field: * Teaching is often interrupted when students work in varying environments, requiring valuable instructor time to help set up their systems so they may complete their assignments. * Students may lack the hardware needed to run the software required for assignments. * Students may lack the bandwidth needed to download large data products to their local computers. -## How is OpenSARlab different from Binder? +## How is OpenSARLab different from Binder? - Authenticated user accounts - User group management @@ -40,13 +40,13 @@ OpenSARlab alleviates some of the pitfalls commonly encountered when teaching so - Deployable to other AWS accounts - Developer defined server timeouts (not restricted to 10 minutes of inactivity) -## How to Access OpenSARlab +## How to Access OpenSARLab ### As a Paid Service Managed by Alaska Satellite Facility Enterprise -Contact ASF-E () to discuss options for setting up an OpenSARlab deployment to suit your needs. +Contact ASF-E () to discuss options for setting up an OpenSARLab deployment to suit your needs. -### Deploy OpenSARlab to Your Own AWS Account _(Coming Soon)_ +### Deploy OpenSARLab to Your Own AWS Account _(Coming Soon)_ Take our publicly accessible codebase and create your own, self-managed deployments in Amazon AWS. diff --git a/docs/release-notes/release_02-2022.md b/docs/release-notes/release_02-2022.md index 8618f5f..1d10f57 100644 --- a/docs/release-notes/release_02-2022.md +++ b/docs/release-notes/release_02-2022.md @@ -1,4 +1,4 @@ -# Welcome to the February 2022 OpenSARlab Update! +# Welcome to the February 2022 OpenSARLab Update! ### Changes: - Ubuntu 20.04.3 LTS diff --git a/docs/user-guides/OpenSARlab_terminal.md b/docs/user-guides/OpenSARlab_terminal.md index dd7f633..756a1c6 100644 --- a/docs/user-guides/OpenSARlab_terminal.md +++ b/docs/user-guides/OpenSARlab_terminal.md @@ -1,6 +1,6 @@ [Return to Table of Contents](../user.md) -# **Using the Terminal in OpenSARlab** +# **Using the Terminal in OpenSARLab** ## Overview --- diff --git a/docs/user-guides/class_notebooks_best_practices.md b/docs/user-guides/class_notebooks_best_practices.md index 652f932..f4761ba 100644 --- a/docs/user-guides/class_notebooks_best_practices.md +++ b/docs/user-guides/class_notebooks_best_practices.md @@ -4,7 +4,7 @@ ## Provide a Conda Environment Capable of Running the Notebooks -- Provide students with a conda environment that has everything they need. [Conda Environments in OpenSARlab.](conda_environments.md) +- Provide students with a conda environment that has everything they need. [Conda Environments in OpenSARLab.](conda_environments.md) - Students can mimic instructor's environment by: @@ -34,7 +34,7 @@ ## Keep your Conda Environment Up to Date - Libraries and packages installed in your conda environment will be updated over time. If you are using a conda environment that was used in a previous class or training, try re-creating it first to confirm that it still builds without any conflicts. - - You can use the [Create_OSL_Conda_Environments notebook](https://github.com/ASFOpenSARlab/opensarlab-envs/blob/main/Create_OSL_Conda_Environments.ipynb) in OpenSARlab to create them, which is located in the `/home/jovyan/conda_environments/` directory. + - You can use the [Create_OSL_Conda_Environments notebook](https://github.com/ASFOpenSARLab/opensarlab-envs/blob/main/Create_OSL_Conda_Environments.ipynb) in OpenSARLab to create them, which is located in the `/home/jovyan/conda_environments/` directory. --- diff --git a/docs/user-guides/conda_environments.md b/docs/user-guides/conda_environments.md index 2611811..48a8b2e 100644 --- a/docs/user-guides/conda_environments.md +++ b/docs/user-guides/conda_environments.md @@ -1,6 +1,6 @@ [Return to Table of Contents](../user.md) -# Creating and Using Conda Environments in OpenSARlab +# Creating and Using Conda Environments in OpenSARLab OpenScienceLab comes with a default `base` conda environment with a minimum amount of software installed. Users must create their own conda environments to run Jupyter Notebooks or Python scripts. @@ -26,7 +26,7 @@ Your environment will be ready after running the last cell. **NB**: It may take a while to generate your conda environment. - +