Skip to content

Commit 514f912

Browse files
committed
⚰️ dead(hello_seqera): remove unused portions of basic training
1 parent 77c234f commit 514f912

File tree

4 files changed

+1
-192
lines changed

4 files changed

+1
-192
lines changed

.devcontainer/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"ms-python.vscode-pylance",
2424
"nf-core.nf-core-extensionpack",
2525
"nextflow.nextflow",
26-
"codezombiech.gitignore",
26+
"codezombiech.gitignore"
2727
]
2828
}
2929
},

docs/hello_nextflow/10_hello_seqera.md

Lines changed: 0 additions & 154 deletions
Original file line numberDiff line numberDiff line change
@@ -19,157 +19,3 @@ You can use Seqera Platform via either the **CLI**, through the **online GUI** o
1919
--8<-- "docs/hello_nextflow/seqera/01_run_with_cli.md"
2020

2121
--8<-- "docs/hello_nextflow/seqera/02_run_with_launchpad.md"
22-
23-
--8<-- "docs/hello_nextflow/seqera/03_add_compute_environment.md"
24-
25-
--8<-- "docs/hello_nextflow/seqera/04_setup_launchpad.md"
26-
27-
!!! Warning WORK-IN-PROGRESS
28-
29-
Everything below this note is content that was copied from the original guide and needs to be moved or rewritten into the above sub-pages.
30-
31-
## Online GUI
32-
33-
To run using the GUI, there are three main steps:
34-
35-
1. Create an account and login into Seqera Platform, available free of charge, at [cloud.seqera.io](https://cloud.seqera.io).
36-
2. Create and configure a new [compute environment](https://docs.seqera.io/platform/24.1/compute-envs/overview).
37-
3. Start [launching pipelines](https://docs.seqera.io/platform/24.1/launch/launchpad#launchpad).
38-
39-
### Selecting a default compute environment
40-
41-
If you have more than one **Compute Environment**, you can select which one will be used by default when launching a pipeline.
42-
43-
1. Navigate to your [compute environments](https://docs.seqera.io/platform/24.1/compute-envs/overview).
44-
2. Choose your default environment by selecting the **Make primary** button.
45-
46-
**Congratulations!**
47-
48-
You are now ready to launch workflows with your primary compute environment.
49-
50-
### Launchpad
51-
52-
Launchpad makes it easy for any workspace user to launch a pre-configured pipeline.
53-
54-
![Launchpad](img/overview_launch.png)
55-
56-
A pipeline is a repository containing a Nextflow workflow, a compute environment and workflow parameters.
57-
58-
### Pipeline Parameters Form
59-
60-
Launchpad automatically detects the presence of a `nextflow_schema.json` in the root of the repository and dynamically creates a form where users can easily update the parameters.
61-
62-
!!! info
63-
64-
The parameter forms view will appear if the pipeline has a Nextflow schema file for the parameters. Please refer to the [Nextflow Schema guide](https://docs.seqera.io/platform/24.1/pipeline-schema/overview) to learn more about the schema file use-cases and how to create them.
65-
66-
This makes it trivial for users without any expertise in Nextflow to enter their workflow parameters and launch.
67-
68-
![Pipeline parameters](img/launch_rnaseq_nextflow_schema.png)
69-
70-
### Adding a new pipeline
71-
72-
Adding a pipeline to the pre-saved workspace launchpad is detailed in full on the [Seqera webpage docs](https://docs.seqera.io/platform/24.1/launch/launchpad#add-new-pipeline).
73-
74-
In brief, these are the steps you need to follow to set up a pipeline.
75-
76-
1. Select the Launchpad button in the navigation bar. This will open the **Launch Form**.
77-
2. Select a [compute environment](https://docs.seqera.io/platform/24.1/compute-envs/overview).
78-
3. Enter the repository of the workflow you want to launch. e.g. <https://github.com/nf-core/rnaseq.git>
79-
4. Select a workflow **Revision number**. The Git default branch (main/master) or `manifest.defaultBranch` in the Nextflow configuration will be used by default.
80-
5. Set the **Work directory** location of the Nextflow work directory. The location associated with the compute environment will be selected by default.
81-
6. Enter the name(s) of each of the Nextflow **Config profiles** followed by the `Enter` key. See the Nextflow [Config profiles](https://www.nextflow.io/docs/latest/config.html#config-profiles) documentation for more details.
82-
7. Enter any workflow parameters in YAML or JSON format. YAML example:
83-
84-
```yaml
85-
reads: "s3://nf-bucket/exome-data/ERR013140_{1,2}.fastq.bz2"
86-
paired_end: true
87-
```
88-
89-
8. Select Launch to begin the pipeline execution.
90-
91-
!!! info
92-
93-
Nextflow workflows are simply Git repositories and can be changed to any public or private Git-hosting platform. See [Git Integration](https://docs.seqera.io/platform/24.1/git/overview) in the Seqera Platform docs and [Pipeline Sharing](https://www.nextflow.io/docs/latest/sharing.html) in the Nextflow docs for more details.
94-
95-
!!! note
96-
97-
The credentials associated with the compute environment must be able to access the work directory.
98-
99-
!!! info
100-
101-
In the configuration, the full path to a bucket must be specified with single quotes around strings and no quotes around booleans or numbers.
102-
103-
!!! tip
104-
105-
To create your own customized Nextflow Schema for your workflow, see the examples from the `nf-core` workflows that have adopted this approach. For example, [eager](https://github.com/nf-core/eager/blob/2.3.3/nextflow_schema.json) and [rnaseq](https://github.com/nf-core/rnaseq/blob/3.0/nextflow_schema.json).
106-
107-
For advanced settings options check out this [page](https://docs.seqera.io/platform/24.1/launch/launchpad#advanced-settings).
108-
109-
There is also community support available if you get into trouble, join the Nextflow Slack by following this [link](https://www.nextflow.io/slack-invite.html).
110-
111-
!!! cboard-list-2 "Summary"
112-
113-
In this step you have learned:
114-
115-
1. How to create an account and login into Seqera Platform
116-
2. How to configure your compute environment.
117-
3. How to add, customize, and launch a pipeline with Seqera Platform.
118-
119-
## API
120-
121-
To learn more about using the Seqera Platform API, visit the [API section](https://docs.seqera.io/platform/24.1/api/overview) in the documentation.
122-
123-
## Workspaces and Organizations
124-
125-
Seqera Platform simplifies the development and execution of pipeline by providing a centralized interface for users and organizations.
126-
127-
Each user has a unique **workspace** where they can interact and manage all resources such as workflows, compute environments and credentials. Details of this can be found [here](https://docs.seqera.io/platform/24.1/getting-started/workspace-setup).
128-
129-
Organizations can have multiple workspaces with customized access for specific organization **members** and **collaborators**.
130-
131-
### Organization resources
132-
133-
You can create your own organization and participant workspace by following the docs at [Seqera](https://docs.seqera.io/platform/24.1/orgs-and-teams/workspace-management).
134-
135-
Seqera Platform allows the creation of multiple organizations, each of which can contain multiple workspaces with shared users and resources. This allows any organization to customize and organize the usage of resources while maintaining an access control layer for users associated with a workspace.
136-
137-
### Organization users
138-
139-
Any user can be added or removed from a particular organization or a workspace and can be allocated a specific access role within that workspace.
140-
141-
The Teams feature provides a way for organizations to group various users and participants together into teams. For example, `workflow-developers` or `analysts`, and apply access control to all the users within this team collectively.
142-
143-
For further information, please refer to the [User Management](https://docs.seqera.io/platform/24.1/orgs-and-teams/organizations) section.
144-
145-
### Setting up a new organization
146-
147-
Organizations are the top-level structure and contain Workspaces, Members, Teams and Collaborators.
148-
149-
To create a new Organization:
150-
151-
1. Click on the dropdown next to your name and select New organization to open the creation dialog.
152-
2. On the dialog, fill in the fields as per your organization. The Name and Full name fields are compulsory.
153-
154-
!!! note
155-
156-
A valid name for the organization must follow a specific pattern. Please refer to the UI for further instructions.
157-
158-
3. The rest of the fields such as Description, Location, Website URL and Logo Url are optional.
159-
4. Once the details are filled in, you can access the newly created organization using the organization’s page, which lists all of your organizations.
160-
161-
!!! note
162-
163-
It is possible to change the values of the optional fields either using the Edit option on the organization’s page or by using the Settings tab within the organization page, provided that you are the Owner of the organization.
164-
165-
!!! tip
166-
167-
A list of all the included Members, Teams and Collaborators can be found on the organization page.
168-
169-
!!! cboard-list-2 "Summary"
170-
171-
In this step you have learned:
172-
173-
1. How to create a new organization
174-
2. How to access the newly created organization
175-
3. How to change organization settings

docs/hello_nextflow/seqera/03_add_compute_environment.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

docs/hello_nextflow/seqera/04_setup_launchpad.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)