Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: roadmap #162

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

feat: roadmap #162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c4b43c2
feat: deleted remark to TODO items, referenced roadmap
cmeesters Oct 11, 2024
48f10d3
feat: first public road map file
cmeesters Oct 11, 2024
a13d84e
fix: syntax
cmeesters Oct 11, 2024
0dfbe5d
fix: added an item on publication of workflows and a comment
cmeesters Oct 11, 2024
19a9038
Update Roadmap.md
cmeesters Oct 14, 2024
3d29dba
Update Roadmap.md - more to do items
cmeesters Oct 14, 2024
f6aee38
feat: added reference to array and pool jobs, LSF support inserted
cmeesters Oct 16, 2024
c9e7b73
fix: merge conflict, apparently array and pool were already mentioned
cmeesters Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,9 @@ In essence, every detail is configurable. Developers can be approached to add ne

## Progress

Currently, the LaTeX code contains TODO and FIXME items. They should all be removed and become githug issues. In order to list TODO items, run the `todo` script, e.g.
If you want to take part, contact us. We have an internal roadmap and meet on a regular basis (online).

```bash
$ todo slides/
```

Otherwise, create issue reports.
To get an idea of our roadmap, [take a look at it](https://github.com/cmeesters/snakemake-hpc-teaching-material/Roadmap.md).

## LaTeX specialities

Expand Down
17 changes: 17 additions & 0 deletions Roadmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Roadmap

- [ ] introducing parallel execution (systematically) `threads` and more - to be implemented Oct/Nov 24
- [ ] benchmarking - to be implemented Oct/Nov 24
- [x] Task(s) as Parson problems - first introduced in PR #158
- [ ] group jobs vs. wrappers with task setting Oct24
- [ ] more Parson problem task settings
- [ ] remote files - no date set
- [ ] MPI-examples with task - Dec24
- [ ] publishing workflows - no date set
- [ ] LSF support - March 2025, after Snakemake Hackathon
- [ ] introducing scatter-gather rules - Jan/Feb 2025
- [ ] introducing SLURM/LSF-job arrays - no date set (feature not present in plugins, yet)
- [ ] introducing pool-Jobs - no date set (feature not present in plugins, yet)
- [ ] demonstration of stage-in procedure - no date set (patch pending)
Comment on lines +3 to +15
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Improve consistency in formatting and structure of roadmap items.

There are several inconsistencies in the formatting of roadmap items that could be addressed to improve readability and clarity:

  1. Date formatting: Standardize the date format across all items. For example, use "Oct/Nov 2024" instead of "Oct/Nov 24" or "Dec24".
  2. Capitalization: Use consistent capitalization for item descriptions. Consider using sentence case for all items.
  3. Task status: While some items use checkboxes ([ ] or [x]), others don't. Consider using checkboxes consistently for all items.
  4. Level of detail: Some items have more context than others. Try to provide a consistent level of detail across all items.

Here's an example of how you could revise the first few items for consistency:

- [ ] Introduce systematic parallel execution:
  - Implement `threads` and other parallelization methods (Oct/Nov 2024)
  - Introduce scatter-gather rules (Jan/Feb 2025)
  - Implement SLURM/LSF-job arrays (Date TBD - awaiting plugin support)
  - Implement pool-Jobs (Date TBD - awaiting plugin support)
- [ ] Conduct benchmarking (Oct/Nov 2024)
- [x] Implement Task(s) as Parson problems (Completed in PR #158)
- [ ] Enhance job management:
  - Group jobs vs. wrappers with task setting (Oct 2024)
  - Demonstrate stage-in procedure (Date TBD - patch pending)

This structure provides more consistency and groups related items together.


Note: We also have issues that reflect additional "wish-list" items and to-do tasks for the project.
Loading