Skip to content

Latest commit

 

History

History
128 lines (83 loc) · 3.26 KB

index.md

File metadata and controls

128 lines (83 loc) · 3.26 KB
Raw
title keywords tags sidebar permalink summary
Workshop Scheduler
homepage
homepage
mydoc_sidebar
index
These brief instructions will help you get started quickly with the theme. The other topics in this help provide additional information and detail about working with other aspects of this theme and Jekyll.

About

When organising a Carpentries workshop a website is created for the workshop using the Carpentries workshop template (https://github.com/carpentries/workshop-template). The workshop template includes a schedule which shows the start and end times of each episode for every day including break times. This program allows a user to capture the start time of a session and the length (in minutes) of all the episodes. The program also allows break and lunch times to be inserted at any point. The program provides for initial keybard input or input from a csv file. Once the user is happy with the schedule it can be exported as an html table which can then be included in the workshop website repository saved as a file called schedule.html.

Project Team

Dr Jannetta Steyn (jannetta.steyn@newcastle.ac.uk)
Danny Watson ([https://github.com/dkwdaft/])

RSE Contact

Jannetta Steyn RSE Team
Newcastle University
(jannetta.steyn@newcastle.ac.uk)

Built With

Getting Started

Prerequisites

  • Python 3.10
  • Windows, Linux or Mac

Installation

install libraries and Dependencies

  • tkinter pip3 install tk

  • Linux users should also install python3-tk sudo apt-get install python3-tk

  • pandastable pip3 install pandastable

Clone the repository

git clone https://github.com/NewcastleRSE/WorkshopScheduler.git

Running Locally

  • run main.py cd [Path to Repository] then python3.10 main.py

Running Tests

TBD

Deployment

Local

TBD

Production

TBD

Usage

TBD

Roadmap

  • Initial Research
  • Minimum viable product <-- You are Here
  • Alpha Release
  • Feature-Complete Release

Contributing

gh-pages Branch

https://newcastlerse.github.io/WorkshopScheduler/index

Main Branch

Protected and can only be pushed to via pull requests. Should be considered stable and a representation of production code.

Dev Branch

Should be considered fragile, code should compile and run but features may be prone to errors.

Feature Branches

A branch per feature being worked on.

https://nvie.com/posts/a-successful-git-branching-model/

License

Citiation

Please cite the associated papers for this work if you use this code:

@article{xxx2021paper,
  title={Title},
  author={Author},
  journal={arXiv},
  year={2021}
}

Acknowledgements