Welcome to the Light Dark Matter eXperiment! This is the central page for documenting our software. Here, you will find manually written documents as well as links to other manuals related to the software. This site is generated using mdbook which has a helpful page on how to read a site formatted like this. All of the pages are hosted here except for the pages in the Reference section which are links to the manuals hosted at different sites.

Below is a list of past video tutorials that are available online. Some of them may be out of date, but they can still be helpful in defining what kind of vocabulary we often use. The first section of this manual is text-based information about how to get started using (and eventually developing) ldmx-sw.

This manual is separated into two main sections based on how you are interacting with ldmx-sw.

  • Using is when you are running ldmx-sw with fire and are not actively changing code within ldmx-sw (i.e. you can fix the version of ldmx-sw you are using for your work).
  • Developing is when you are actively changing code within ldmx-sw and so need to compile ldmx-sw yourself.

Using and Developing

Notice that this categorization only cares about the ldmx-sw source code. People using ldmx-sw very often are still developing code that may just not be within ldmx-sw. Additionally, whether or not you are developing ldmx-sw may change depending on the project you are working on. Perhaps you find a bug or think of a new feature -- contributions are encouraged and welcome!