Skip to content

Commit b1fdd82

Browse files
authored
Sphinx Documentation: Restructure (#1821)
The big restructuring & streamlining of our documentation.
1 parent 8534530 commit b1fdd82

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+2738
-897
lines changed

CODE_OF_CONDUCT.md

-76
This file was deleted.

CODE_OF_CONDUCT.rst

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
.. _coc:
2+
3+
Code of Conduct
4+
===============
5+
6+
Our Pledge
7+
----------
8+
9+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
10+
11+
Our Standards
12+
-------------
13+
14+
Examples of behavior that contributes to creating a positive environment include:
15+
16+
- Using welcoming and inclusive language
17+
- Being respectful of differing viewpoints and experiences
18+
- Gracefully accepting constructive criticism
19+
- Focusing on what is best for the community
20+
- Showing empathy towards other community members
21+
22+
Examples of unacceptable behavior by participants include:
23+
24+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
25+
- Trolling, insulting/derogatory comments, and personal or political attacks
26+
- Public or private harassment
27+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
28+
- Other conduct which could reasonably be considered inappropriate in a professional setting
29+
30+
Our Responsibilities
31+
--------------------
32+
33+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
34+
35+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
36+
37+
Scope
38+
-----
39+
40+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
41+
Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
42+
Representation of a project may be further defined and clarified by project maintainers.
43+
44+
Enforcement
45+
-----------
46+
47+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
48+
reported by contacting the project team at warpx-coc@lbl.gov.
49+
All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.
50+
The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
51+
Further details of specific enforcement policies may be posted separately.
52+
53+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
54+
55+
Attribution
56+
-----------
57+
58+
This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org>`_, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
59+
60+
For answers to common questions about this code of conduct, see
61+
https://www.contributor-covenant.org/faq

Docs/source/building/cori.rst

-151
This file was deleted.

Docs/source/coc.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../CODE_OF_CONDUCT.rst

Docs/source/contact_us.rst

-8
This file was deleted.
File renamed without changes.

Docs/source/visualization/advanced.rst Docs/source/dataanalysis/advanced.rst

+3-4
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,13 @@ Advanced yt visualization, for developers (for plotfiles)
22
=========================================================
33

44
This sections contains yt commands for advanced users. The Particle-In-Cell methods uses a
5-
staggered grid (see :doc:`../theory/picsar_theory`), so that the x, y, and z components of the
5+
staggered grid (see :ref:`particle-in-cell theory <theory-pic>`), so that the x, y, and z components of the
66
electric and magnetic fields are all defined at different locations in space. Regular output
77
(see the :doc:`yt` page, or the notebook at ``WarpX/Tools/PostProcessing/Visualization.ipynb`` for an example)
88
returns cell-centered data for convenience, which involves an additional operation. It is sometimes
99
useful to access the raw data directly. Furthermore,
1010
the WarpX implementation for mesh refinement contains a number of grids for each level (coarse,
11-
fine and auxiliary, see
12-
:doc:`../theory/theory` for more details), and it is sometimes useful to access each of
11+
fine and auxiliary, see :ref:`the theory <theory>` for more details), and it is sometimes useful to access each of
1312
them (regular output return the auxiliary grid only). This page provides information to read
1413
raw data of all grids.
1514

@@ -27,7 +26,7 @@ with parameters (``warpx.plot_rho`` only when using back-transformed diagnostics
2726
warpx.plot_dive = 1
2827
warpx.plot_rho = 1
2928
30-
see :doc:`../running_cpp/parameters` for more information on these parameters.
29+
see :ref:`the input parameter section <running-cpp-parameters>` for more information.
3130

3231
Read raw data
3332
-------------
File renamed without changes.

Docs/source/visualization/backtransformed_diags.rst Docs/source/dataanalysis/backtransformed_diags.rst

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
Visualizing back-transformed diagnostics
2-
========================================
1+
.. _dataanalysis-btd:
2+
3+
Back-Transformed Diagnostics
4+
============================
35

46
When running a simulation in a boosted frame, WarpX has the capability to
57
back-transform the simulation results to the laboratory frame of reference, which
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)