Skip to content

Latest commit

 

History

History
57 lines (33 loc) · 3.77 KB

README.md

File metadata and controls

57 lines (33 loc) · 3.77 KB
Raw

SPLICE Research Group Wiki Pages

SPLICE – Surrogate and Particle-in-Cell Learning, Innovation, and Code Exchange

Welcome to the SPLICE Research Group wiki! This space serves as a collaborative platform for researchers working in the fields of machine learning, surrogate modelling, and Particle-in-Cell (PIC) simulations. Whether you are a group member or an external collaborator, we invite you to explore, contribute, and share knowledge.

Contribution Guidelines

We encourage active participation from both group members and external collaborators. Before adding new content, please ensure that your contribution aligns with the goals of SPLICE and adheres to the following guidelines:

  • Use markdown for formatting your pages.
  • To ensure consistency across all wiki pages, we recommend the markdownlint VScode extension when editing the files locally. Once installed, markdownlint will automatically check your files for formatting issues as you edit.
  • Keep your contributions focused on topics relevant to machine learning, surrogate modelling, or PIC codes.
  • Ensure clarity and accuracy in your content.
  • For external contributors, please obtain permission from the group administrators before making any changes.

If you're unsure about the process or need help with contributions, don't hesitate to ask for assistance on Slack or by email.

Frequently Asked Questions (FAQ)

What is the SPLICE Research Group?

The SPLICE Research Group brings together researchers from diverse fields to foster collaboration and tackle common challenges in machine learning, surrogate modelling, and PIC code development. Our aim is to facilitate knowledge exchange, code sharing, and innovation across these areas.

What is the Purpose of This Repository?

This repository provides a comprehensive collection of wiki pages covering topics relevant to our research interests. It serves as a knowledge base for both SPLICE members and external contributors interested in our work.

Who Can Contribute to the Wiki Pages?

These wiki pages are open for contributions by all members of the SPLICE research group. External contributors are welcome but should obtain prior permission before editing or adding content. Please contact the group administrators via Slack or email to request access.

How Can I Add or Edit Wiki Pages?

To add or edit a wiki page, you can either use the GitHub web interface or clone the wiki repository to work locally.

  • Option 1: Edit via GitHub Interface: Follow the step-by-step instructions provided by GitHub here: Adding or Editing Wiki Pages.

  • Option 2: Clone the Wiki Repository:

    1. Clone the wiki repository:

      git clone https://github.com/username/repository.wiki.git

    2. Navigate to the cloned directory and edit your Markdown files locally.

    3. Commit your changes and push them back to the wiki repository.

We recommend using markdown format when writing or editing wiki pages, as demonstrated in Step 4 of the guide.

Where Can I Learn More About GitHub Wikis?

For an overview of how GitHub Wikis work, check out the About GitHub Wikis page. If you still have questions or need further assistance, feel free to reach out via our Slack channel or email group.

Have Suggestions or Improvements?

We welcome any feedback or suggestions you may have regarding this README or the wiki pages. Whether it's content updates, formatting tweaks, or additional resources, your input helps us improve. Feel free contribute directly by editing this document!