lhcb / starterkit

Central website for all efforts related to the LHCb Starterkit.

Starterkit

The source code for the website for the LHCb Starterkit organisation.

Building the website

The site is built automatically whenever the gh-pages branch is updated on GitHub.

To build the site locally, you need to install the github-pages gem and then run Jekyll, a program that converts the collection of HTML templates and Markdown files in this repository to full HTML pages. Assuming you have Ruby installed on your machine, which should be the case on anything but Windows, inside this repository you can do:

$ gem install bundler
$ bundle install --path=vendor/bundle
$ bundle exec jekyll build

(The use of the --path option in bundle install and of bundle exec makes the dependency installation local to the folder containing the repository, so that your ‘global’ list of gems isn't touched.)

This will build the site into the _site directory, and you can then open _site/index.html in your browser to see the site.

To have Jekyll monitor the repository for changes and serve the website on a local development server, do:

$ bundle exec jekyll serve --watch

You can visit the site using the local address http://127.0.0.1:4000/starterkit/.

starterkit's Issues

Ambitious mission statement

We should define a clear mission statement like "Bringing LHCb software to the 21st century" and include it in the website's header.

See Culture & Empire chapter 2 for reference.

Report on Run II

The page for "Starterkit Run II" is still a stub. It should be filled to resemble "First Starterkit".

Projects for 2019 Impactkit

We should start making notes of project ideas for the next Impactkit:

• Outreach ideas (especially in preparation for the open days in September 2019)

As I can't assign you: @andriiusachov

Travis

Set up Travis to build the page as a rudimentary check.

URLs for software carpentry

Hi!

There are a few links on bash/git pointing to: http://twitwi.github.io/2015-06-02-cern-lhcb/
I think it would be better to point to: https://software-carpentry.org/lessons/ where are the lessons.

Example:

Cheers,
Ana

Starterkit November 2016

Domain

We could get something like lhcb-starterkit.web.cern.ch with little effort I think.
Ideally lhcb-starterkit.cern but I have no idea how to go about that.

Grammtical mistake/unclear wording in "Changes to data flow in Run2"

The text to the section "Changes to data flow in Run2" contains the following sentence:

That is to say, any tracks or detector responses that don't form part of the decay that the trigger lines uses to evaluate its selection is thrown away.

"Trigger lines" is plural, but the following verb "uses" is singular. Unfortunately I cannot correct this because I really don't know what the right answer is.

Are tracks really thrown away until they contribute to trigger any of the L0, Hlt1, oder Hlt2 lines? Doesn't that throw away a lot of good TIS events?

Thank Secretariat in the Starterkit Autumn 2016 page

I'm afraid we completely forgot about mentioning them!

Touch/fav-icons

Oh yeah. http://stackoverflow.com/questions/23849377/html-5-favicon-support

Update site following May 2016 Impactkit

Update the Impactkit post giving a summary of what happened, pictures, feedback, and so on.

New template for *-analysis-steps

The current template for the lessons is based on the software carpentry template. It has served us well, but I think we can do better.

I'd like us to discuss two things: moving to a different lesson template, and the possibility of merging the two lesson repos.

Changing the lesson template

Pros

1. It works! We've been using the lesson templates for three workshops now.
2. It doesn't look terrible.
3. We've had to spend very little time fiddling with layouts and CSS and blah, just concentrated on the content.

Cons

1. We never got around to fully customising the template; e.g. some links in the footer still point to Software Carpentry stuff.
2. It doesn't look particularly nice. Could have proper syntax highlighting, could match the style of the central site, have a better layout, and so on.
3. We would have to do some designing/website building, and it's hard enough getting the content ready in time.

Having a single lessons repository

This is just an idea I had.

I'm not sure if there's a big benefit in having two repos, first- and second-analysis steps. We could just have a single lhcb-starterkit-lessons repo, which we can pick and chose from when putting together a course. Then we don't have to have clumsy links referring to lessons in “the first Starterkit” or “in First Analysis Steps”; everything will be easy to find because it's all on one page.

(I had students in the Impactkit who didn't realise/forgot that we'd already taught some things in first-analysis-steps that they could use for stuff in second-*. Having all the lessons visible on a single index might help.)

Link to lhcbqa.web.cern.ch/

This is a proposal inform students about the existence of https://lhcbqa.web.cern.ch/ somewhere in the lessons.

If you have a suggestion where to add it, I can make a pull request.

Font and icons

There seems to be a problem related to the fonts.

This doesn't match the screenshots in the PR.

Participant feedback and thank you email

We should prepare a Google Form for the participants to fill in, asking a few questions about how they found the course overall. The email with the link can also act as the ‘closing message’ from the organisers, thanking people for coming, for actively participating, etc.

Some ideas for questions:

• What aspects of the course did you really like (or: what things did we do well)?
• What things did you dislike (or: what things could we do better)?
• Did you enjoy the projects day?
  • Liked the project you were assigned?
  • Would have preferred a larger choice of projects?
  • Supervisor(s) gave you enough support?
  • Felt satisfied with the outcome?
  • Would you have preferred to have more of the usual lessons instead?
• Would you recommend a course like Impactkit to other students?

Tmux / screen in starterkit

Hi!

This is just an idea to add to the LHCb starterkit.
Tmux / screen are very handy tools for running scripts, and (searching for a few minutes this repo) I don't think they are now included, but probably should be mentioned.
Both are installed on lxplus.
PS: I can help to create an example and description.

Cheers,
Ana

Responsive design

Just discovered that the beautiful design doesn't do so well on mobile. WDYT about going single column for mobile?

CONTRIBUTING.md

Add standard contributing document. Main point is to explain how to build the pages locally as well as list the default rules and guidelines etc. LICENSE aussi?

Summary of Spring 2017 Impactkit

A huge thanks and congratulations to Svende and Lorenzo (not on GitHub ‼️❓) for organising the most recent Impactkit! I think it went pretty darn well 😄

The final task is to write a summary page, saying what happened, how things went, adding a few nice photos, and thanking everyone involved. The page for the last Starterkit should give us an idea.

Ganga, grid usage, etc: Which practices are good and which are bad?

I've had mixed responses to practices I've learned from the Starterkit from people in Distributed Analysis, about a couple of things:

HTCondor usage

corresp. page: https://lhcb.github.io/starterkit-lessons/self-guided-lessons/htcondor.html

Apparently using HTCondor / LXBATCH is against LHCb fair usage policy? See
https://mattermost.web.cern.ch/lhcb/channels/distributed-analysis/s7ckr86kwpyxubu3n6mfsxupia

Replication of grid files to CERN-USER storage elements for analysis purposes

corresp. page: https://lhcb.github.io/starterkit-lessons/second-analysis-steps/managing-files-with-ganga.html
I've been discouraged from doing this, and told I should instead access my files by authenticating with a grid certificate.

links to the individual material on the front page

Would be good to link directly to the individual material sites from the front page.

test, 1, 2, 3

slacking?

Project follow-ups for May 2016 Impactkit

I think the project supervisors should contact the project groups to summarise the progress made during the project day. This will give the students a chance to have any questions they didn't ask on Friday, and for the supervisors to give the students some more ideas to write about.

One of my projects will be continuing, so the email will be an opportunity to discuss what the team will be doing.

Hackathon projects for 2020 Impactkit

Following on from last year's issue (#47)

• Upgrade
  • Simulation: porting decay models and cut tools over, @dominikmuller?
  • OATF work packages? Particularly WP1, WP2 and WP3
• Outreach
  • Masterclass
  • Event display
  • Contact outreach WG?

Page that lists the contributors for each year

From @ibab in lhcb/first-analysis-steps#155:

Makes it easier to find out who helped and instructed and gives everyone a fuzzy feeling

Migrate away from GitBook

At some point we should consider moving from GitBook to something else as the CLI interface we use is no longer maintained and contains various bugs. We could consider moving to CERN GitLab, but this would only apply to the LHCb repositories and we might not want to maintain multiple CI pipelines. I think the preference is to use a "popular" static site generator in the hope that we avoid being stuck with an abandonded tool.

Essential features:

• Full text search
• LaTeX math rendering
• Syntax highlighting
• Collapseable pop outs for challenges or additional details

Potentially desirable features:

• Better support for viewing/downloading code files
• Testing of code snippets (ALICE are already doing this)
• Printable for teachers to use as a reference
• Tempate and CI maintained outside of the documentation repository to allow it to be updated in a single place
• Able to ingest Jupyter notebooks for the Python lessons

Update link to lessons

Should we link to https://lhcb.github.io/starterkit-lessons instead of the first and second analysis steps?

Add event page for November 2016 Starterkit

It's that time of year!