From ead360d2745641082023e95141123fa3a74b5ecf Mon Sep 17 00:00:00 2001 From: Juraj Smiesko Date: Tue, 30 Jul 2024 17:27:51 +0200 Subject: [PATCH 1/5] Updating Contribution instructions --- CONTRIBUTING.md | 91 ++++++++++++------------- LICENSE.md | 32 +++------ README.md | 25 +++++-- conf.py | 4 +- developing-fcc-software/FccDocPage.md | 96 +++++++++------------------ software-basics/README.md | 2 +- 6 files changed, 106 insertions(+), 144 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3969e7d4..382e9613 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,16 @@ (contributing-lesson)= # Contributing -[starterkit-lessons][repo] is an open source project, and we welcome contributions of all kinds: +[FCC Software][fcc-software] is an open source project, and we welcome +contributions of all kinds: * New lessons; * Fixes to existing material; * Bug reports; and * Reviews of proposed changes. -By contributing, you are agreeing that we may redistribute your work under [these licenses][license]. +By contributing, you are agreeing that we may redistribute your work under +[these licenses][license]. You also agree to abide by our [contributor code of conduct][conduct]. ## Getting Started @@ -25,90 +27,81 @@ You also agree to abide by our [contributor code of conduct][conduct]. 5. If you're looking for things to work on, please see [the list of issues for this repository][issues]. Comments on issues and reviews of pull requests are equally welcome. + ## Building the lessons -### Using `venv` (recommended) +### Requirements -#### Requirements -Make sure you have `venv` (virtual environment) in your working directory. It can be created with the following command: -``` +Make sure you have `venv` (virtual environment) in your working directory. It +can be created with the following command: +```shell $ python3 -m venv venv ``` -Activate it in the shell and install the requirements, which are gathered in a file provided by the repository. -``` +Activate it in your shell and install the requirements, which are gathered in a +file provided by the repository. +```shell $ source venv/bin/activate $ pip3 install -r requirements.txt ``` After sourcing, your shell prompt will be augmented by the `(venv)` prefix, e.g. -``` +```shell (venv) mylaptop:~/fcc/fcc-tutorials ``` -:::{admonition} Building `fcc-tutorials` in FCCSW stack -:class: solution +:::{admonition} Building `fcc-tutorials` in FCC Software stack +:class: callout -In case the Python from FCCSW stack is being used, it is necessary to clear -`PYTHONPATH` environment variable after sourcing of the stack -``` +In case the Python from the FCC Software stack is being used, it is necessary to +clear `PYTHONPATH` environment variable after sourcing of the stack +```shell source /cvmfs/fcc.cern.ch/sw/latest/setup.sh unset PYTHONPATH ``` Sourcing of the FCCSW stack might be needed in cases when the Python provided by -the OS is too old, currently this is the case for CentOS 7 (`lxplus`). +the OS is too old, currently this is the case for CentOS 7 (`lxplus7`). ::: -#### Building +### Building + The documentation pages are build by executing -``` +```shell $ sphinx-build -b html . build ``` -#### Browsing the result -Open in your browser the file -``` -$PWD/build/index.html -``` +### Browsing the result -### Using `starterkit_ci` +Start a web server to host the generated files from `build` directory +```shell +$ cd build +$ python -m http.server +``` -#### Requirements +You should be able to see your local version by opening a web-browser and +navigating to [http://localhost:8000](http://localhost:8000). -To build the lessons locally, install the following: -1. [starterkit-ci](https://pypi.org/project/starterkit-ci/) +## How to Write Documentation -#### Building -Build the pages: +More information about how to write the documentation/tutorials for the FCC +Software visit +[](./developing-fcc-software/FccDocPage.md#writing-documentation-for-the-fcc-software). -```shell -$ starterkit_ci build --allow-warnings -$ starterkit_ci check --allow-warnings -``` +## Legal -#### Browsing the result -Start a web server to host them: +```{eval-rst} +.. toctree:: -```shell -$ cd build -$ python -m http.server 8000 + CONDUCT.md + LICENSE.md ``` -You can see your local version by using a web-browser to navigate to `http://localhost:8000` or wherever it says it's serving the book. + +[fcc-software]: https://fccsw.web.cern.ch/ [conduct]: CONDUCT.md -[repo]: https://github.com/HEP-FCC/fcc-tutorials -[issues]: https://github.com/HEP-FCC/fcc-tutorials/issues [license]: LICENSE.md +[issues]: https://github.com/HEP-FCC/fcc-tutorials/issues [pro-git-chapter]: http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project [gh-fork]: https://help.github.com/en/articles/fork-a-repo [gh-pull]: https://help.github.com/en/articles/about-pull-requests [gh-fork-pull]: https://reflectoring.io/github-fork-and-pull/ - - -```{eval-rst} -.. toctree:: - :hidden: - - CONDUCT.md - LICENSE.md -``` diff --git a/LICENSE.md b/LICENSE.md index 1998afa3..f5a9fccd 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,7 +1,9 @@ -# Instructional Material +# License + +## Instructional Material All instructional material is made available under the [Creative Commons -Attribution license][cc-by-human]. The following is a human-readable summary of +Attribution license][cc-by-human]. The following is a human-readable summary of (and not a substitute for) the [full legal text of the CC BY 4.0 license][cc-by-legal]. @@ -34,31 +36,15 @@ Notices: necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material. -# Software - -Except where otherwise noted, the example programs and other software provided -by Software Carpentry are made available under the [OSI][osi]-approved [MIT -license][mit-license]. -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies -of the Software, and to permit persons to whom the Software is furnished to do -so, subject to the following conditions: +## Software -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. +Except where otherwise noted, the example programs and other software provided +by Software Carpentry are made available under the [OSI][osi]-approved +[Apache 2.0][apache-license] license. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. [cc-by-human]: https://creativecommons.org/licenses/by/4.0/ [cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode -[mit-license]: https://opensource.org/licenses/mit-license.html +[apache-license]: https://opensource.org/license/apache-2-0/ [osi]: https://opensource.org diff --git a/README.md b/README.md index 8a04716f..4aec22a2 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,33 @@ # The FCC Tutorials -These are the lessons taught during the [FCC Tutorials][tutorial] (the format is heavily inspired by the [LHCb starterkit][lhcb-starterkit]). -If you'd like to join the next tutorial, visit [the FCCSW website][fccsw-website] to find out when it will happen and how to sign up. +These are the lessons taught during the [FCC Software Tutorials][tutorial] (the +format is heavily inspired by the [LHCb starterkit][lhcb-starterkit]). -If you'd just like to learn about how to use the FCC software, [read on][first-analysis-steps]! +List of previous workshop/tutorial events: +* [FCC Software Hands-on Tutorial](https://indico.cern.ch/event/1182767/) at + CERN; 19--21 October 2022. +* [Software tutorial](https://indico.cern.ch/event/945608/timetable/?layout=room#147-link-to-software-tutorial) + in the context of the Snowmass 2021 studies; 22, 23 and 29 September 2020. +* [Software tutorial](https://indico.cern.ch/event/838435/timetable/?layout=room#147-link-to-software-tutorial) as part of the FCC Physics week; 15 January 2020. +* [Software Workshop and hands-on tutorial](https://indico.cern.ch/event/839794/) on 2-3 October 2019; an introduction to many topics. + +The next tutorial, will be anounced in +[FCC-PED-SoftwareAndComputing-Documentation](https://e-groups.cern.ch/e-groups/Egroup.do?egroupName=FCC-PED-SoftwareAndComputing-Documentation) e-group, make sure you +are subscribed in order to know how to sign up. + +If you'd just like to learn about how to use the FCC Software, +[read on][first-steps]! [fccsw-website]: https://cern.ch/fccsw [tutorial]: https://hep-fcc.github.io/fcc-tutorials [lhcb-starterkit]: https://lhcb.github.io/starterkit-lessons/index.html -[first-analysis-steps]: https://hep-fcc.github.io/fcc-tutorials/software-basics/README.html +[first-steps]: ./software-basics/README.md#first-steps ```{eval-rst} .. toctree:: :numbered: - :maxdepth: 3 + :maxdepth: 2 :includehidden: :caption: Contents: @@ -34,5 +47,5 @@ If you'd just like to learn about how to use the FCC software, [read on][first-a FCCSW main page FCCAnalyses reference documentation Analysis essentials - FCC software glossary + FCC Software glossary ``` diff --git a/conf.py b/conf.py index c5a9ff28..96a9f9f5 100644 --- a/conf.py +++ b/conf.py @@ -1,7 +1,7 @@ # import sphinx_rtd_theme project = 'FCC Tutorials' -copyright = '2023, CERN' +copyright = '2024, CERN' html_logo = '_static/img/fcc-logo-light.png' html_favicon = '_static/img/favicon.ico' html_theme = 'sphinx_rtd_theme' @@ -19,7 +19,7 @@ 'display_github': True, 'github_user': 'HEP-FCC', 'github_repo': 'fcc-tutorials', - 'github_version': 'master/', + 'github_version': 'main/', } extensions = [ diff --git a/developing-fcc-software/FccDocPage.md b/developing-fcc-software/FccDocPage.md index 978d44b9..de306770 100644 --- a/developing-fcc-software/FccDocPage.md +++ b/developing-fcc-software/FccDocPage.md @@ -1,82 +1,34 @@ -# Writing documentation for the FCC software +# Writing documentation for the FCC Software ## Where to put documentation -- API documentation of classes and functions is done with Doxygen notation in the source code. -- Slightly higher level documentation on usage of a piece of software is usually put directly in the corresponding repository. -- Long-form documentations that introduce users to a piece of software belong in [fcc-tutorials](https://hep-fcc.github.io/fcc-tutorials/). +- API documentation of classes and functions should be done using Doxygen + notation directly in the source code. +- Slightly higher level documentation on usage of a piece of software is + usually put directly in the corresponding repository. +- Long-form documentations that introduces users to a piece of software belongs + into [fcc-tutorials](https://hep-fcc.github.io/fcc-tutorials/). :::{admonition} Where to put documentation :class: callout -It is sometimes difficult to decide between the last two. In those cases either will be great. +It is sometimes difficult to decide between the last two. In those cases either +will be great. ::: -## When and how is the documentation page updated? +## How to write Mardown -There are both a main website () and a readthedocs-style page for the tutorials (). - -Both consists of a static website based on `github-pages`. The main website points to EOS (`/eos/project/f/fccsw-web/www`), from where it is redirected to the github-pages site of FCCSW. Only members -of the corresponding e-group have write access. All markdown and configuration files are stored in the [`gh-pages`](https://github.com/HEP-FCC/FCCSW/tree/gh-pages) branch of the -FCCSW Github repository. All dependencies (jquery, bootstrap-sass) are included in the mentioned repository and any change should be automatically deployed to: - -[http://hep-fcc.github.io/FCCSW/](http://hep-fcc.github.io/FCCSW/) - - -## Structure of the content of the main page - -Folders can be added to aggregate markdown files by category: - -- `computing`: FCC Computing Resources -- `presentations`: Selection of Publications and Presentations relating to FCC Software -... - -The rest of folders and files are mainly configuration files to generate the website itself with [Jekyll](https://jekyllrb.com/): - -- `_data`: Contains `permalinks.yaml` YAML file with the links shown on the website -- `_includes`: HTML files to define the structure of the website (header, footer, ...) -- `_layouts`: HTML Structure for those part that are commonly used (posts, sites, title headers, ...) -- `css`: Define the style of the website -- `geo`: Geometry visualization -- `node_modules`: Contains Javascript installed dependencies -- `Gemfile`: Define Ruby dependencies -- `package.json`: Define Javascript dependencies -- `_config`: General configuration file with metadata used by Jekyll - - -## Running website generation locally - -**This is meant for testing not to override the generated website!** - -Modify the content and serve the page with: - -```bash -jekyll serve --baseurl= -``` - -Now you should be able to see the website at `localhost:4000`. - - -### About jekyll - -We are using jekyll to build our website. If you are interested in extending the website have a look in -the [repository](https://github.com/HEP-FCC/FCCSW/tree/gh-pages). Documentation of jekyll may be found -[elsewhere](https://jekyllrb.com/). In case of questions contact the fcc-experiments-sw-dev mailing list. - - -## For website admins - -Administrators controlling access to the webspace need to be members of the e-group `cernbox-project-fccsw-web-admins`. - -If you want to have write-access you need to request membership in -`cernbox-project-fccsw-web-writers`. If you are the main responsible for these activities, you should own the service account `fccsweos` that has admin rights for both the physics data EOS space and the web EOS space. +This tutorial website is generated with [Sphinx](https://www.sphinx-doc.org/) +machinery using [Read the Docs](https://readthedocs.org/). Specific parser of +Mardown we use is [MyST](https://myst-parser.readthedocs.io). ## Custom Admonitions -The `fcc-tutorial` makes use of custom admonition classes: +The `fcc-tutorial` makes use of the following custom admonition classes +inherited from [LHCb Starterkit](https://lhcb.github.io/starterkit-lessons/): * prereq * callout @@ -120,3 +72,21 @@ Text of a collapsable admonition. Text of a collapsable admonition. ::: + + +## When and how is the tutorials page updated? + +This tutorials page is hosted at and +the edits are managed using Github pull requests. Once the pull request is +merged the change to the tutorials page will happen within few minutes. + + +## For website admins + +Administrators controlling access to the webspace need to be members of the +`cernbox-project-fccsw-web-admins` e-group. + +If you want to have write-access you need to request membership in +`cernbox-project-fccsw-web-writers`. If you are the main responsible for these +activities, you should own the service account `fccsweos` that has admin rights +for both the physics data EOS space and the web EOS space. diff --git a/software-basics/README.md b/software-basics/README.md index 3a78d5a3..5a14a0d2 100644 --- a/software-basics/README.md +++ b/software-basics/README.md @@ -1,4 +1,4 @@ -# First Steps +# First Steps This is the FCC Tutorials, a series of lessons for getting physicists working confidently with FCC data and software. The lessons are best approached one after the other, as most lessons build on the knowledge gained from the previous ones. From 50d3ca19432af12e9f9506b7f1f26dcef9ad4da2 Mon Sep 17 00:00:00 2001 From: Juraj Smiesko Date: Wed, 31 Jul 2024 09:44:59 +0200 Subject: [PATCH 2/5] Add tutorials from 2023 & 2024 --- README.md | 7 +++++++ developing-fcc-software/FccDocPage.md | 4 ++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4aec22a2..119de917 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,13 @@ These are the lessons taught during the [FCC Software Tutorials][tutorial] (the format is heavily inspired by the [LHCb starterkit][lhcb-starterkit]). List of previous workshop/tutorial events: +* Computing and software tutorials as part of + [Second Annual U.S. Future Circular Collider (FCC) Workshop 2024](https://indico.mit.edu/event/876/) + at MIT; 25--27 Mar 2024. +* Software tutorials as part of + [First Annual U.S. Future Circular Collider (FCC) Workshop 2023](https://www.bnl.gov/usfccworkshop/) + ([Indico](https://indico.cern.ch/event/1244371/)) at Brookhaven National + Laboratory; 24--26 April 2023. * [FCC Software Hands-on Tutorial](https://indico.cern.ch/event/1182767/) at CERN; 19--21 October 2022. * [Software tutorial](https://indico.cern.ch/event/945608/timetable/?layout=room#147-link-to-software-tutorial) diff --git a/developing-fcc-software/FccDocPage.md b/developing-fcc-software/FccDocPage.md index de306770..9d0c07b3 100644 --- a/developing-fcc-software/FccDocPage.md +++ b/developing-fcc-software/FccDocPage.md @@ -21,8 +21,8 @@ will be great. ## How to write Mardown This tutorial website is generated with [Sphinx](https://www.sphinx-doc.org/) -machinery using [Read the Docs](https://readthedocs.org/). Specific parser of -Mardown we use is [MyST](https://myst-parser.readthedocs.io). +machinery using [Read the Docs](https://readthedocs.org/) theme. Specific +parser of Mardown we use is [MyST](https://myst-parser.readthedocs.io). ## Custom Admonitions From b8ace6ec6e688368993dd2bbf536ceec697fe586 Mon Sep 17 00:00:00 2001 From: Juraj Smiesko Date: Wed, 31 Jul 2024 09:48:04 +0200 Subject: [PATCH 3/5] Updated external links --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 119de917..ec1a7e99 100644 --- a/README.md +++ b/README.md @@ -51,8 +51,9 @@ If you'd just like to learn about how to use the FCC Software, :includehidden: :caption: External links: - FCCSW main page - FCCAnalyses reference documentation + FCC Software + FCC-ee Detector Full Sim + FCCAnalyses Analysis essentials FCC Software glossary ``` From 94f90725af4d302fafbd1bc6fd144f3f41794b45 Mon Sep 17 00:00:00 2001 From: Juraj Smiesko Date: Wed, 31 Jul 2024 10:05:26 +0200 Subject: [PATCH 4/5] Replacing http:// with https:// --- CONTRIBUTING.md | 2 +- developing-fcc-software/FccSoftwareGit.md | 2 +- fast-sim-and-analysis/EventProduction.md | 4 ++-- fast-sim-and-analysis/FccFastSimGeneration.md | 12 ++++++------ .../FCCeeGeneralOverview/FCCeeGeneralOverview.md | 2 +- software-basics/prerequisites.md | 2 +- software-basics/swan.md | 2 +- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 382e9613..37f9a99c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -101,7 +101,7 @@ Software visit [conduct]: CONDUCT.md [license]: LICENSE.md [issues]: https://github.com/HEP-FCC/fcc-tutorials/issues -[pro-git-chapter]: http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project +[pro-git-chapter]: https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project [gh-fork]: https://help.github.com/en/articles/fork-a-repo [gh-pull]: https://help.github.com/en/articles/about-pull-requests [gh-fork-pull]: https://reflectoring.io/github-fork-and-pull/ diff --git a/developing-fcc-software/FccSoftwareGit.md b/developing-fcc-software/FccSoftwareGit.md index 7dde1fe8..b1c5c07b 100644 --- a/developing-fcc-software/FccSoftwareGit.md +++ b/developing-fcc-software/FccSoftwareGit.md @@ -11,7 +11,7 @@ code. For a general introduction to git, have a look at these tutorials: - [Atlassian tutorial](https://www.atlassian.com/git/tutorials/) -- [Interactive tutorial](http://pcottle.github.io/learnGitBranching/) +- [Interactive tutorial](https://pcottle.github.io/learnGitBranching/) - [The git book](https://git-scm.com/book/en/v2) ## First time setup of git diff --git a/fast-sim-and-analysis/EventProduction.md b/fast-sim-and-analysis/EventProduction.md index 8a3f82c4..b538e2b9 100644 --- a/fast-sim-and-analysis/EventProduction.md +++ b/fast-sim-and-analysis/EventProduction.md @@ -181,12 +181,12 @@ Pythia8 card (in this case `p8_ee_default.cmd`), that does not include specific decays nor specific matching/merging parameters. ::: -To assist you in writing your own Pythia8 configuration cards, the manual is available [here](http://home.thep.lu.se/~torbjorn/pythia81html/Welcome.html) +To assist you in writing your own Pythia8 configuration cards, the manual is available [here](https://pythia.org/latest-manual/Welcome.html) ## Expert mode The following commands should be run with care, as they update the database, web-page etc... -They run automatically every four hours with crontab, thus you will eventually know when your samples are ready to be used by browsing the corresponding configuration on this [web-page](http://fcc-physics-events.web.cern.ch/). +They run automatically every four hours with crontab, thus you will eventually know when your samples are ready to be used by browsing the corresponding configuration on this [web-page](https://fcc-physics-events.web.cern.ch/). The `--force` option is used to force the script to run in order to optimize running time, processes that have not been flagged will not be checked. ### Updating the database diff --git a/fast-sim-and-analysis/FccFastSimGeneration.md b/fast-sim-and-analysis/FccFastSimGeneration.md index f13eccfa..5ed297e3 100644 --- a/fast-sim-and-analysis/FccFastSimGeneration.md +++ b/fast-sim-and-analysis/FccFastSimGeneration.md @@ -756,9 +756,9 @@ i.e. 1458.0 +- 7.7 pb. ### Generating ditaus with Whizard As explained in the dedicated [Whizard section](#whizard), to use `whizard` we need a `Sindarin` configuration file. To generate ditau events we will use the file -[Z_tautau.sin](http://fccsw.web.cern.ch/tutorials/apr2023/tutorial1/Z_tautau.sin): +[Z_tautau.sin](https://fccsw.web.cern.ch/tutorials/apr2023/tutorial1/Z_tautau.sin): ``` -$ wget http://fccsw.web.cern.ch/tutorials/apr2023/tutorial1/Z_tautau.sin +$ wget https://fccsw.web.cern.ch/tutorials/apr2023/tutorial1/Z_tautau.sin ``` and run it in a dedicate directory to not pollute the working one with the many files produced: ``` @@ -783,7 +783,7 @@ The first lines of the `LHEf` file give the total cross-section: 1.508 +- 2 pb, In order to get the events in `EDM4hep` format, we exploit the fact that `Pythia` provides `LHEf` reader functionality. To activate that we will use `Gaudi` and special `.cmd` file the consider the input `LHEf` input file as a `Beam`. This special `.cmd` is called `p8_lhereader.cmd` and it is available on the web: ``` S cd ../cards -wget http://fccsw.web.cern.ch/tutorials/apr2023/tutorial1/p8_lhereader.cmd +wget https://fccsw.web.cern.ch/tutorials/apr2023/tutorial1/p8_lhereader.cmd ``` Please note the lines ``` @@ -952,7 +952,7 @@ i.e the total ditau cross-section at 91.2 GeV from `KKMCee` is 1485.5 +- 0.007 p In order to get the events in `EDM4hep` format, we will use `Gaudi` and the tools available in [k4FWCore](https://github.com/key4hep/k4FWCore) and [k4Gen](https://github.com/HEP-FCC/k4Gen/). We need a Gaudi steering file that reads the `HepMC` file and writes out the `EDM4hep` file. A minimal version of such a steering code is available on the tutorial reference page: ``` -wget http://fccsw.web.cern.ch/tutorials/apr2023/tutorial1/hepmc2edm.py +wget https://fccsw.web.cern.ch/tutorials/apr2023/tutorial1/hepmc2edm.py ``` Let's see what it does: that is shown by the first line of the help function ``` @@ -1096,7 +1096,7 @@ Now we are ready to go. #### Creating histograms with FCCAnalyses At this purpose we will use the recently introduced `build_graph` attribute. The example is availble at -[histmaker_ttmm.py](http://fccsw.web.cern.ch/tutorials/apr2023/tutorial1/histmaker_ttmm.py). +[histmaker_ttmm.py](https://fccsw.web.cern.ch/tutorials/apr2023/tutorial1/histmaker_ttmm.py). ##### Dissection of `histmaker_ttmm.py` @@ -1193,7 +1193,7 @@ total 24 #### Comparing distributions FCCAnalyses provides the `plots` option to prepare some plots. A possible way to plot the histos is available at -[plots_ttmm.py](http://fccsw.web.cern.ch/tutorials/apr2023/tutorial1/plots_ttmm.py), which can run as +[plots_ttmm.py](https://fccsw.web.cern.ch/tutorials/apr2023/tutorial1/plots_ttmm.py), which can run as ``` $ fccanalysis plots plots_ttmm.py ``` diff --git a/full-detector-simulations/FCCeeGeneralOverview/FCCeeGeneralOverview.md b/full-detector-simulations/FCCeeGeneralOverview/FCCeeGeneralOverview.md index 65375815..2afbcc34 100644 --- a/full-detector-simulations/FCCeeGeneralOverview/FCCeeGeneralOverview.md +++ b/full-detector-simulations/FCCeeGeneralOverview/FCCeeGeneralOverview.md @@ -36,7 +36,7 @@ Let's first run the CLD Geant4 simulation, through ddsim, for some $e^{+}e^{-} \ git clone https://github.com/key4hep/CLDConfig.git cd CLDConfig/CLDConfig # retrieve Z(mumu)H(X) MC generator events -wget http://fccsw.web.cern.ch/fccsw/tutorials/MIT2024/wzp6_ee_mumuH_ecm240_GEN.stdhep.gz +wget https://fccsw.web.cern.ch/fccsw/tutorials/MIT2024/wzp6_ee_mumuH_ecm240_GEN.stdhep.gz gunzip wzp6_ee_mumuH_ecm240_GEN.stdhep.gz # run the Geant4 simulation ddsim -I wzp6_ee_mumuH_ecm240_GEN.stdhep -N 10 -O wzp6_ee_mumuH_ecm240_CLD_SIM.root --compactFile $K4GEO/FCCee/CLD/compact/CLD_o2_v05/CLD_o2_v05.xml --steeringFile cld_steer.py diff --git a/software-basics/prerequisites.md b/software-basics/prerequisites.md index dc7ab8c7..8f2e3ce1 100644 --- a/software-basics/prerequisites.md +++ b/software-basics/prerequisites.md @@ -61,7 +61,7 @@ is still available. ## Special notes or alternative cases / settings ### Bash shell -The [Bash shell](http://cern.ch/go/gdJ9) will be used +The [Bash shell](https://cern.ch/go/gdJ9) will be used throughout the workshop. The default for new computing accounts is now Bash. If you have an older account, the default used to be a shell called `tcsh` diff --git a/software-basics/swan.md b/software-basics/swan.md index ff6e19d0..69d4dff9 100644 --- a/software-basics/swan.md +++ b/software-basics/swan.md @@ -9,7 +9,7 @@ SWAN is a web service for running jupyter notebooks at CERN, and is a very convenient way of running tutorials if one has a CERN computing account. -SWAN can be used only with a browser and is reached by visiting . +SWAN can be used only with a browser and is reached by visiting . After logging in, SWAN will ask you to configure your session. The default software stack (`102` at the moment can be kept, but to use the Key4hep, software the following environment script has to be used: ``` From 54bb29cad84500be8744bd9a85698c1835e0b5ed Mon Sep 17 00:00:00 2001 From: Juraj Smiesko Date: Wed, 31 Jul 2024 10:41:20 +0200 Subject: [PATCH 5/5] Updated cross reference --- .../FCCeeGeneralOverview/FCCeeGeneralOverview.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/full-detector-simulations/FCCeeGeneralOverview/FCCeeGeneralOverview.md b/full-detector-simulations/FCCeeGeneralOverview/FCCeeGeneralOverview.md index 2afbcc34..509c3dbd 100644 --- a/full-detector-simulations/FCCeeGeneralOverview/FCCeeGeneralOverview.md +++ b/full-detector-simulations/FCCeeGeneralOverview/FCCeeGeneralOverview.md @@ -313,7 +313,11 @@ From there, you can navigate the geometry hierarchy to see how volumes are neste :align: center ``` -This tool is useful but not perfect and will not meet all the needs (especially if you want to overlay a physics event). To go further, other solutions are described in the dedicated [Visualization](https://hep-fcc.github.io/fcc-tutorials/main/full-detector-simulations/Visualization/Visualization.html) tutorial. +This tool is useful but not perfect and will not meet all the needs (especially +if you want to overlay a physics event). To go further, other solutions are +described in the dedicated +[Visualization](../Visualization/Visualization.md#visualization) +tutorial. ## Additional Resources - [Key4hep tutorial](https://key4hep.github.io/key4hep-doc/setup-and-getting-started/README.html)