Skip to content

Commit

Permalink
Merge pull request #22 from SBNSoftware/mking-doc-days
Browse files Browse the repository at this point in the history
Reformatting the front page and adding in a space for organizational documents
  • Loading branch information
mking99456 authored Dec 4, 2024
2 parents d6bf849 + c5ac7f1 commit d337850
Show file tree
Hide file tree
Showing 5 changed files with 95 additions and 27 deletions.
18 changes: 18 additions & 0 deletions ExperimentDocuments/icarus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: page
title: ICARUS Experiment Documents
subtitle: A wiki for documentation of the ICARUS collaboration
hero_height: is-medium
toc: false
---

# Organizational Documents for ICARUS
* ICARUS Bylaws
* ICARUS Speakers Committee Procedures
* ICARUS Community Agreement

## ICARUS Organizational Chart ##

## Publicly Approved Plots ##

## ICARUS Logos ##
19 changes: 19 additions & 0 deletions ExperimentDocuments/sbn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
layout: page
title: SBN Collaboration Documents
subtitle: A wiki for documentation of the SBN collaboration
hero_height: is-medium
toc: false
---

# Organizational Documents for SBN
* SBN Bylaws
* SBN Code of Conduct

## SBND Organizational Chart ##
* Link to SBN Org Chart

## Publicly Approved Plots ##

## SBND Logos ##
* Link to SBN Logos
20 changes: 20 additions & 0 deletions ExperimentDocuments/sbnd.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
layout: page
title: SBND Experiment Documents
subtitle: A wiki for documentation of the SBND collaboration
hero_height: is-medium
toc: false
---

# Organizational Documents for SBND
* SBND Bylaws
* SBND Speakers Committee Procedures
* SBND Community Agreement

## SBND Organizational Chart ##
* Link to SBND Org Chart

## Publicly Approved Plots ##

## SBND Logos ##
* Link to SBND Logos
30 changes: 19 additions & 11 deletions SBNYoung/SBNYoungIndex.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,34 +9,42 @@ So you've found this page, chances are that means you're a student or postdoc ne
This guide is intended to provide resources to help you get started in SBN. It's a compilation of any guides and documentation we could find / write ourselves and is by no means complete but we hope it helps you get up to speed!
Thanks to the authors of the SBND & ICARUS Newbie Guides from which we ported some of this information.

## Computing ##
### Basic Computing ###
- [Basic Computing](Basic_Computing.md)
*ssh-ing, vnc, access to FNAL services, setting up an mrb environment, etc*
- [Key Physics Concepts](Physics_Concepts.md)
*LArTPC operation, descriptions of PDS and CRT, motivation for short baseline, etc*
- [Producing your own events](LArSoft_Workflow.md)
*Using larsoft to simulate a simple set of events from generation to reconstructed outputs*
- [Simulation](Simulation.md)
*Description of the simulation software*
- [Reconstruction](Reconstruction.md)
*Description of the reconstruction software*
- [Using Pandora for Analysis](Pandora_Outputs.md)
*How to utilise the Pandora reconstrcution outputs for analysis work*
- [The Common Analysis Framework](CAF_Intro.md)
*How to create and use CAF files*
- [Writing a LArSoft analyzer / producer](Writing_with_LArSoft.md)
*Creating your own LArSoft modules*
- [The CI System](Testing_with_the_CI.md)
*How to test your code as you go along*
- [The Working Groups](Working_Groups.md)
*A quick introduction into the work done by the various working groups that make up SBN/SBND/ICARUS*
- [Git/Github](Git_Intro.md)
*How to navigate the wonderful world of git*
- [Doxygen](Using_Doxygen.md)
*How to create documentation for SBN object libraries*
- [Common Acronyms](Acronym_List.md)
*Why does everyone speak in code?!*
- [Using the Grid](Grid_Intro.md)
*How to submit jobs to the FNAL grid computing system*
- [Particle gun and analyzer modules](particle_gun_tut.md)
- [Particle gun and analyzer modules](particle_gun_tut.md)
*Writing a simple fcl to produce particles and how to analyze the output using larsoft files*

### Analysis ###
- [Using Pandora for Analysis](Pandora_Outputs.md)
*How to utilise the Pandora reconstrcution outputs for analysis work*
- [The Common Analysis Framework](CAF_Intro.md)
*How to create and use CAF files*

## Physics ##
- [Key Physics Concepts](Physics_Concepts.md)
*LArTPC operation, descriptions of PDS and CRT, motivation for short baseline, etc*

## Miscellaneous Experiment Stuff ##
- [The Working Groups](Working_Groups.md)
*A quick introduction into the work done by the various working groups that make up SBN/SBND/ICARUS*
- [Common Acronyms](Acronym_List.md)
*Why does everyone speak in code?!*

35 changes: 19 additions & 16 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,35 @@ layout: page
title: SBN Software Wiki
subtitle: A wiki for documentation of the SBN Software packages
hero_height: is-medium
toc: true
toc: false
---


# Welcome to the SBN Software Wiki Page
This page is designed to serve as a hub for SBN collaborators to find what they need.

**New to the SBN Github? Go to the [Github migration to do list](AnalysisInfrastructure/github-migration-to-do-list.md)**
## For New Collaborators ##
If you're looking for a tutorial on one of the many aspects of SBN physics, collaboration, or computing, chances are, you'll find it here:
* [SBN Young Guide](SBNYoung/SBNYoungIndex.md)
* To be broken down into further categories, such as physics and computing

## Collaboration Organization Documents ##
* [SBND](ExperimentDocuments/sbnd.md)
* [ICARUS](ExperimentDocuments/icarus.md)
* [SBN](ExperimentDocuments/sbn.md)

See below for helpful links:
## Software Documentation ###
* [doxygen](doxygen): Auto-generated from the source code, updated nightly
* [LArSoft Wiki](https://larsoft.github.io/LArSoftWiki/)

## Operations ##
* [ICARUS Operations](Operations/SBN_FD/index)
* [SBND Operations](Operations/SBN_ND/index)

## [Analysis Infrastructure](AnalysisInfrastructure/index) ##
New to the SBN Github? Go to the [Github migration to do list](AnalysisInfrastructure/github-migration-to-do-list.md)**
### [How to Add New Features, Fix Bugs, Or Otherwise Develop](AnalysisInfrastructure/how-to-develop) ###

### [LArSoft Wiki](https://larsoft.github.io/LArSoftWiki/) ###

## List of Repositories ##

### Offline Repositories ###
Expand All @@ -44,17 +58,6 @@ See below for helpful links:

* [sbndaq-xporter](https://github.com/SBNSoftware/sbndaq-xporter): Code for online SBN data management


## Documentation ###
* [doxygen](doxygen): Auto-generated from the source code, updated nightly

## Operations ##
* [ICARUS Operations](Operations/SBN_FD/index)
* [SBND Operations](Operations/SBN_ND/index)

## SBN Young Guide ##
* [SBN Young Guide](SBNYoung/SBNYoungIndex.md)

## Contribute to this wiki ##

The content of this wiki is tracked by the [GIT repository SBNSoftware/SBNSoftware.github.io](https://github.com/SBNSoftware/SBNSoftware.github.io).
Expand Down

0 comments on commit d337850

Please sign in to comment.