From e67bec6b2fbdfd13e3111c0033864dda4e4f9d22 Mon Sep 17 00:00:00 2001 From: Axel Kohlmeyer Date: Sun, 4 Dec 2022 16:59:17 -0500 Subject: [PATCH] use consistent pygments language tags --- doc/src/Developer_code_design.rst | 6 ++--- doc/src/Developer_notes.rst | 16 +++++------ doc/src/Developer_plugins.rst | 6 ++--- doc/src/Developer_unittest.rst | 4 +-- doc/src/Developer_updating.rst | 44 +++++++++++++++---------------- doc/src/Developer_utils.rst | 10 +++---- doc/src/Developer_write.rst | 14 +++++----- doc/src/Howto_pylammps.rst | 38 +++++++++++++------------- doc/src/Howto_structured_data.rst | 2 +- doc/src/Library_config.rst | 2 +- doc/src/Library_create.rst | 2 +- doc/src/Library_execute.rst | 2 +- doc/src/Library_properties.rst | 2 +- doc/src/Python_atoms.rst | 4 +-- doc/src/Python_config.rst | 2 +- doc/src/Python_create.rst | 6 ++--- doc/src/Python_error.rst | 2 +- doc/src/Python_execute.rst | 8 +++--- doc/src/Python_launch.rst | 2 +- doc/src/Python_objects.rst | 6 ++--- doc/src/Python_properties.rst | 2 +- doc/src/Python_scatter.rst | 4 +-- 22 files changed, 92 insertions(+), 92 deletions(-) diff --git a/doc/src/Developer_code_design.rst b/doc/src/Developer_code_design.rst index a5c879de82..786bd51c26 100644 --- a/doc/src/Developer_code_design.rst +++ b/doc/src/Developer_code_design.rst @@ -50,7 +50,7 @@ parallel each MPI process creates such an instance. This can be seen in the ``main.cpp`` file where the core steps of running a LAMMPS simulation are the following 3 lines of code: -.. code-block:: C++ +.. code-block:: c++ LAMMPS *lammps = new LAMMPS(argc, argv, lammps_comm); lammps->input->file(); @@ -232,7 +232,7 @@ macro ``PairStyle()`` will associate the style name "lj/cut" with a factory function creating an instance of the ``PairLJCut`` class. -.. code-block:: C++ +.. code-block:: c++ // from force.h typedef Pair *(*PairCreator)(LAMMPS *); @@ -360,7 +360,7 @@ characters; "{:<8}" would do this as left aligned, "{:^8}" as centered, argument type must be compatible or else the {fmt} formatting code will throw an exception. Some format string examples are given below: -.. code-block:: C +.. code-block:: c++ auto mesg = fmt::format(" CPU time: {:4d}:{:02d}:{:02d}\n", cpuh, cpum, cpus); mesg = fmt::format("{:<8s}| {:<10.5g} | {:<10.5g} | {:<10.5g} |{:6.1f} |{:6.2f}\n", diff --git a/doc/src/Developer_notes.rst b/doc/src/Developer_notes.rst index 2b3375265f..a781737d6f 100644 --- a/doc/src/Developer_notes.rst +++ b/doc/src/Developer_notes.rst @@ -105,7 +105,7 @@ list, where each pair of atoms is listed only once (except when the pairs straddling sub-domains or periodic boundaries will be listed twice). Thus these are the default settings when a neighbor list request is created in: -.. code-block:: C++ +.. code-block:: c++ void Pair::init_style() { @@ -129,7 +129,7 @@ neighbor list request to the specific needs of a style an additional request flag is needed. The :doc:`tersoff ` pair style, for example, needs a "full" neighbor list: -.. code-block:: C++ +.. code-block:: c++ void PairTersoff::init_style() { @@ -141,7 +141,7 @@ When a pair style supports r-RESPA time integration with different cutoff region the request flag may depend on the corresponding r-RESPA settings. Here an example from pair style lj/cut: -.. code-block:: C++ +.. code-block:: c++ void PairLJCut::init_style() { @@ -160,7 +160,7 @@ Granular pair styles need neighbor lists based on particle sizes and not cutoff and also may require to have the list of previous neighbors available ("history"). For example with: -.. code-block:: C++ +.. code-block:: c++ if (use_history) neighbor->add_request(this, NeighConst::REQ_SIZE | NeighConst::REQ_HISTORY); else neighbor->add_request(this, NeighConst::REQ_SIZE); @@ -170,7 +170,7 @@ settings each request can set an id which is then used in the corresponding ``init_list()`` function to assign it to the suitable pointer variable. This is done for example by the :doc:`pair style meam `: -.. code-block:: C++ +.. code-block:: c++ void PairMEAM::init_style() { @@ -189,7 +189,7 @@ just once) and this can also be indicated by a flag. As an example here is the request from the ``FixPeriNeigh`` class which is created internally by :doc:`Peridynamics pair styles `: -.. code-block:: C++ +.. code-block:: c++ neighbor->add_request(this, NeighConst::REQ_FULL | NeighConst::REQ_OCCASIONAL); @@ -198,7 +198,7 @@ than what is usually inferred from the pair style settings (largest cutoff of all pair styles plus neighbor list skin). The following is used in the :doc:`compute rdf ` command implementation: -.. code-block:: C++ +.. code-block:: c++ if (cutflag) neighbor->add_request(this, NeighConst::REQ_OCCASIONAL)->set_cutoff(mycutneigh); @@ -212,7 +212,7 @@ for printing the neighbor list summary the name of the requesting command should be set. Below is the request from the :doc:`delete atoms ` command: -.. code-block:: C++ +.. code-block:: c++ neighbor->add_request(this, "delete_atoms", NeighConst::REQ_FULL); diff --git a/doc/src/Developer_plugins.rst b/doc/src/Developer_plugins.rst index 36fdd010b3..dd5431507e 100644 --- a/doc/src/Developer_plugins.rst +++ b/doc/src/Developer_plugins.rst @@ -95,7 +95,7 @@ a class ``PairMorse2`` in the files ``pair_morse2.h`` and ``pair_morse2.cpp`` with the factory function and initialization function would look like this: -.. code-block:: C++ +.. code-block:: c++ #include "lammpsplugin.h" #include "version.h" @@ -141,7 +141,7 @@ list of argument strings), then the pointer type is ``lammpsplugin_factory2`` and it must be assigned to the *creator.v2* member of the plugin struct. Below is an example for that: -.. code-block:: C++ +.. code-block:: c++ #include "lammpsplugin.h" #include "version.h" @@ -176,7 +176,7 @@ demonstrated in the following example, which also shows that the implementation of the plugin class may be within the same source file as the plugin interface code: -.. code-block:: C++ +.. code-block:: c++ #include "lammpsplugin.h" diff --git a/doc/src/Developer_unittest.rst b/doc/src/Developer_unittest.rst index aff6128e9c..69e29263a6 100644 --- a/doc/src/Developer_unittest.rst +++ b/doc/src/Developer_unittest.rst @@ -194,7 +194,7 @@ macro. These tests operate by capturing the screen output when executing the failing command and then comparing that with a provided regular expression string pattern. Example: -.. code-block:: C++ +.. code-block:: c++ TEST_F(SimpleCommandsTest, UnknownCommand) { @@ -249,7 +249,7 @@ MPI support. These include tests where LAMMPS is run in multi-partition mode or only on a subset of the MPI world communicator. The CMake script code for adding this kind of test looks like this: -.. code-block:: CMake +.. code-block:: cmake if (BUILD_MPI) add_executable(test_library_mpi test_library_mpi.cpp) diff --git a/doc/src/Developer_updating.rst b/doc/src/Developer_updating.rst index 90a138d2cf..c02d6763de 100644 --- a/doc/src/Developer_updating.rst +++ b/doc/src/Developer_updating.rst @@ -61,7 +61,7 @@ header file needs to be updated accordingly. Old: -.. code-block:: C++ +.. code-block:: c++ int PairEAM::pack_comm(int n, int *list, double *buf, int pbc_flag, int *pbc) { @@ -75,7 +75,7 @@ Old: New: -.. code-block:: C++ +.. code-block:: c++ int PairEAM::pack_forward_comm(int n, int *list, double *buf, int pbc_flag, int *pbc) { @@ -112,14 +112,14 @@ Example from a pair style: Old: -.. code-block:: C++ +.. code-block:: c++ if (eflag || vflag) ev_setup(eflag, vflag); else evflag = vflag_fdotr = eflag_global = eflag_atom = 0; New: -.. code-block:: C++ +.. code-block:: c++ ev_init(eflag, vflag); @@ -142,14 +142,14 @@ when they are called from only one or a subset of the MPI processes. Old: -.. code-block:: C++ +.. code-block:: c++ val = force->numeric(FLERR, arg[1]); num = force->inumeric(FLERR, arg[2]); New: -.. code-block:: C++ +.. code-block:: c++ val = utils::numeric(FLERR, true, arg[1], lmp); num = utils::inumeric(FLERR, false, arg[2], lmp); @@ -183,14 +183,14 @@ copy them around for simulations. Old: -.. code-block:: C++ +.. code-block:: c++ fp = force->open_potential(filename); fp = fopen(filename, "r"); New: -.. code-block:: C++ +.. code-block:: c++ fp = utils::open_potential(filename, lmp); @@ -207,7 +207,7 @@ Example: Old: -.. code-block:: C++ +.. code-block:: c++ if (fptr == NULL) { char str[128]; @@ -217,7 +217,7 @@ Old: New: -.. code-block:: C++ +.. code-block:: c++ if (fptr == nullptr) error->one(FLERR, "Cannot open AEAM potential file {}: {}", filename, utils::getsyserror()); @@ -237,7 +237,7 @@ an example from the ``FixWallReflect`` class: Old: -.. code-block:: C++ +.. code-block:: c++ FixWallReflect(class LAMMPS *, int, char **); virtual ~FixWallReflect(); @@ -247,7 +247,7 @@ Old: New: -.. code-block:: C++ +.. code-block:: c++ FixWallReflect(class LAMMPS *, int, char **); ~FixWallReflect() override; @@ -271,7 +271,7 @@ the type of the "this" pointer argument. Old: -.. code-block:: C++ +.. code-block:: c++ comm->forward_comm_pair(this); comm->forward_comm_fix(this); @@ -284,7 +284,7 @@ Old: New: -.. code-block:: C++ +.. code-block:: c++ comm->forward_comm(this); comm->reverse_comm(this); @@ -304,7 +304,7 @@ requests can be :doc:`found here `. Example from the Old: -.. code-block:: C++ +.. code-block:: c++ int irequest = neighbor->request(this,instance_me); neighbor->requests[irequest]->pair = 0; @@ -317,7 +317,7 @@ Old: New: -.. code-block:: C++ +.. code-block:: c++ auto req = neighbor->add_request(this, NeighConst::REQ_OCCASIONAL); if (cutflag) req->set_cutoff(mycutneigh); @@ -340,7 +340,7 @@ these are internal fixes, there is no user visible change. Old: -.. code-block:: C++ +.. code-block:: c++ #include "fix_store.h" @@ -351,7 +351,7 @@ Old: New: -.. code-block:: C++ +.. code-block:: c++ #include "fix_store_peratom.h" @@ -362,7 +362,7 @@ New: Old: -.. code-block:: C++ +.. code-block:: c++ #include "fix_store.h" @@ -373,7 +373,7 @@ Old: New: -.. code-block:: C++ +.. code-block:: c++ #include "fix_store_global.h" @@ -396,7 +396,7 @@ the dump directly. Example: Old: -.. code-block:: C++ +.. code-block:: c++ int idump = output->find_dump(arg[iarg+1]); if (idump < 0) @@ -412,7 +412,7 @@ Old: New: -.. code-block:: C++ +.. code-block:: c++ auto idump = output->get_dump_by_id(arg[iarg+1]); if (!idump) error->all(FLERR,"Dump ID {} in hyper command does not exist", arg[iarg+1]); diff --git a/doc/src/Developer_utils.rst b/doc/src/Developer_utils.rst index b92d817d87..7c44ccfe56 100644 --- a/doc/src/Developer_utils.rst +++ b/doc/src/Developer_utils.rst @@ -317,7 +317,7 @@ are all "whitespace" characters, i.e. the space character, the tabulator character, the carriage return character, the linefeed character, and the form feed character. -.. code-block:: C++ +.. code-block:: c++ :caption: Tokenizer class example listing entries of the PATH environment variable #include "tokenizer.h" @@ -349,7 +349,7 @@ tokenizer into a ``try`` / ``catch`` block to handle errors. The when a (type of) number is requested as next token that is not compatible with the string representing the next word. -.. code-block:: C++ +.. code-block:: c++ :caption: ValueTokenizer class example with exception handling #include "tokenizer.h" @@ -427,7 +427,7 @@ one or two array indices "[]" with numbers > 0. A typical code segment would look like this: -.. code-block:: C++ +.. code-block:: c++ :caption: Usage example for ArgInfo class int nvalues = 0; @@ -476,7 +476,7 @@ open the file, and will call the :cpp:class:`LAMMPS_NS::Error` class in case of failures to read or to convert numbers, so that LAMMPS will be aborted. -.. code-block:: C++ +.. code-block:: c++ :caption: Use of PotentialFileReader class in pair style coul/streitz PotentialFileReader reader(lmp, file, "coul/streitz"); @@ -555,7 +555,7 @@ chunk size needs to be known in advance, 2) with :cpp:func:`MyPage::vget() its size is registered later with :cpp:func:`MyPage::vgot() `. -.. code-block:: C++ +.. code-block:: c++ :caption: Example of using :cpp:class:`MyPage ` #include "my_page.h" diff --git a/doc/src/Developer_write.rst b/doc/src/Developer_write.rst index bdc6559060..c374ec2e77 100644 --- a/doc/src/Developer_write.rst +++ b/doc/src/Developer_write.rst @@ -26,7 +26,7 @@ constructor with the signature: ``FixPrintVel(class LAMMPS *, int, char **)``. Every fix must be registered in LAMMPS by writing the following lines of code in the header before include guards: -.. code-block:: c +.. code-block:: c++ #ifdef FIX_CLASS // clang-format off @@ -47,7 +47,7 @@ keyword when it parses the input script. Let's write a simple fix which will print the average velocity at the end of each timestep. First of all, implement a constructor: -.. code-block:: C++ +.. code-block:: c++ FixPrintVel::FixPrintVel(LAMMPS *lmp, int narg, char **arg) : Fix(lmp, narg, arg) @@ -72,7 +72,7 @@ in the Fix class called ``nevery`` which specifies how often the method The next method we need to implement is ``setmask()``: -.. code-block:: C++ +.. code-block:: c++ int FixPrintVel::setmask() { @@ -87,7 +87,7 @@ during execution. The constant ``END_OF_STEP`` corresponds to the are called during a timestep and the order in which they are called are shown in the previous section. -.. code-block:: C++ +.. code-block:: c++ void FixPrintVel::end_of_step() { @@ -143,7 +143,7 @@ The group membership information of an atom is contained in the *mask* property of and atom and the bit corresponding to a given group is stored in the groupbit variable which is defined in Fix base class: -.. code-block:: C++ +.. code-block:: c++ for (int i = 0; i < nlocal; ++i) { if (atom->mask[i] & groupbit) { @@ -174,7 +174,7 @@ to store positions of atoms from previous timestep, we need to add ``double** xold`` to the header file. Than add allocation code to the constructor: -.. code-block:: C++ +.. code-block:: c++ FixSavePos::FixSavePos(LAMMPS *lmp, int narg, char **arg), xold(nullptr) { @@ -190,7 +190,7 @@ to the constructor: Implement the aforementioned methods: -.. code-block:: C++ +.. code-block:: c++ double FixSavePos::memory_usage() { diff --git a/doc/src/Howto_pylammps.rst b/doc/src/Howto_pylammps.rst index 6c788e2365..a182d4a050 100644 --- a/doc/src/Howto_pylammps.rst +++ b/doc/src/Howto_pylammps.rst @@ -152,14 +152,14 @@ Creating a new instance of PyLammps To create a PyLammps object you need to first import the class from the lammps module. By using the default constructor, a new *lammps* instance is created. -.. code-block:: Python +.. code-block:: python from lammps import PyLammps L = PyLammps() You can also initialize PyLammps on top of this existing *lammps* object: -.. code-block:: Python +.. code-block:: python from lammps import lammps, PyLammps lmp = lammps() @@ -180,14 +180,14 @@ For instance, let's take the following LAMMPS command: In the original interface this command can be executed with the following Python code if *L* was a lammps instance: -.. code-block:: Python +.. code-block:: python L.command("region box block 0 10 0 5 -0.5 0.5") With the PyLammps interface, any command can be split up into arbitrary parts separated by white-space, passed as individual arguments to a region method. -.. code-block:: Python +.. code-block:: python L.region("box block", 0, 10, 0, 5, -0.5, 0.5) @@ -199,14 +199,14 @@ The benefit of this approach is avoiding redundant command calls and easier parameterization. In the original interface parameterization needed to be done manually by creating formatted strings. -.. code-block:: Python +.. code-block:: python L.command("region box block %f %f %f %f %f %f" % (xlo, xhi, ylo, yhi, zlo, zhi)) In contrast, methods of PyLammps accept parameters directly and will convert them automatically to a final command string. -.. code-block:: Python +.. code-block:: python L.region("box block", xlo, xhi, ylo, yhi, zlo, zhi) @@ -256,7 +256,7 @@ LAMMPS variables can be both defined and accessed via the PyLammps interface. To define a variable you can use the :doc:`variable ` command: -.. code-block:: Python +.. code-block:: python L.variable("a index 2") @@ -265,14 +265,14 @@ A dictionary of all variables is returned by L.variables you can access an individual variable by retrieving a variable object from the L.variables dictionary by name -.. code-block:: Python +.. code-block:: python a = L.variables['a'] The variable value can then be easily read and written by accessing the value property of this object. -.. code-block:: Python +.. code-block:: python print(a.value) a.value = 4 @@ -284,7 +284,7 @@ LAMMPS expressions can be immediately evaluated by using the eval method. The passed string parameter can be any expression containing global thermo values, variables, compute or fix data. -.. code-block:: Python +.. code-block:: python result = L.eval("ke") # kinetic energy result = L.eval("pe") # potential energy @@ -298,7 +298,7 @@ All atoms in the current simulation can be accessed by using the L.atoms list. Each element of this list is an object which exposes its properties (id, type, position, velocity, force, etc.). -.. code-block:: Python +.. code-block:: python # access first atom L.atoms[0].id @@ -311,7 +311,7 @@ position, velocity, force, etc.). Some properties can also be used to set: -.. code-block:: Python +.. code-block:: python # set position in 2D simulation L.atoms[0].position = (1.0, 0.0) @@ -328,7 +328,7 @@ after a run via the L.runs list. This list contains a growing list of run data. The first element is the output of the first run, the second element that of the second run. -.. code-block:: Python +.. code-block:: python L.run(1000) L.runs[0] # data of first 1000 time steps @@ -339,14 +339,14 @@ the second run. Each run contains a dictionary of all trajectories. Each trajectory is accessible through its thermo name: -.. code-block:: Python +.. code-block:: python L.runs[0].thermo.Step # list of time steps in first run L.runs[0].thermo.Ke # list of kinetic energy values in first run Together with matplotlib plotting data out of LAMMPS becomes simple: -.. code-block:: Python +.. code-block:: python import matplotlib.plot as plt steps = L.runs[0].thermo.Step @@ -406,7 +406,7 @@ Four atoms are placed in the simulation and the dihedral potential is applied on them using a datafile. Then one of the atoms is rotated along the central axis by setting its position from Python, which changes the dihedral angle. -.. code-block:: Python +.. code-block:: python phi = [d \* math.pi / 180 for d in range(360)] @@ -439,7 +439,7 @@ Initially, a 2D system is created in a state with minimal energy. It is then disordered by moving each atom by a random delta. -.. code-block:: Python +.. code-block:: python random.seed(27848) deltaperturb = 0.2 @@ -458,7 +458,7 @@ It is then disordered by moving each atom by a random delta. Finally, the Monte Carlo algorithm is implemented in Python. It continuously moves random atoms by a random delta and only accepts certain moves. -.. code-block:: Python +.. code-block:: python estart = L.eval("pe") elast = estart @@ -517,7 +517,7 @@ PyLammps can be run in parallel using mpi4py. This python package can be install The following is a short example which reads in an existing LAMMPS input file and executes it in parallel. You can find in.melt in the examples/melt folder. -.. code-block:: Python +.. code-block:: python from mpi4py import MPI from lammps import PyLammps diff --git a/doc/src/Howto_structured_data.rst b/doc/src/Howto_structured_data.rst index 18a5dfd775..3fe630a120 100644 --- a/doc/src/Howto_structured_data.rst +++ b/doc/src/Howto_structured_data.rst @@ -43,7 +43,7 @@ JSON "ke": $(ke) }""" file current_state.json screen no -.. code-block:: JSON +.. code-block:: json :caption: current_state.json { diff --git a/doc/src/Library_config.rst b/doc/src/Library_config.rst index 04b12f35de..481edcee7c 100644 --- a/doc/src/Library_config.rst +++ b/doc/src/Library_config.rst @@ -39,7 +39,7 @@ crashes within LAMMPS may be recovered from by enabling :ref:`exceptions `, avoiding them proactively is a safer approach. -.. code-block:: C +.. code-block:: c :caption: Example for using configuration settings functions #include "library.h" diff --git a/doc/src/Library_create.rst b/doc/src/Library_create.rst index 8ccc2e80ce..546db9b3be 100644 --- a/doc/src/Library_create.rst +++ b/doc/src/Library_create.rst @@ -22,7 +22,7 @@ as the "handle" argument in subsequent function calls until that instance is destroyed by calling :cpp:func:`lammps_close`. Here is a simple example demonstrating its use: -.. code-block:: C +.. code-block:: c #include "library.h" #include diff --git a/doc/src/Library_execute.rst b/doc/src/Library_execute.rst index 201d9c01b0..44b601ba4c 100644 --- a/doc/src/Library_execute.rst +++ b/doc/src/Library_execute.rst @@ -30,7 +30,7 @@ be included in the file or strings, and expansion of variables with ``${name}`` or ``$(expression)`` syntax is performed. Below is a short example using some of these functions. -.. code-block:: C +.. code-block:: c /* define to make the otherwise hidden prototype for "lammps_open()" visible */ #define LAMMPS_LIB_MPI diff --git a/doc/src/Library_properties.rst b/doc/src/Library_properties.rst index dfd72adc95..b3a8f9ea5a 100644 --- a/doc/src/Library_properties.rst +++ b/doc/src/Library_properties.rst @@ -32,7 +32,7 @@ indexed accordingly. Per-atom data can change sizes and ordering at every neighbor list rebuild or atom sort event as atoms migrate between sub-domains and processors. -.. code-block:: C +.. code-block:: c #include "library.h" #include diff --git a/doc/src/Python_atoms.rst b/doc/src/Python_atoms.rst index be0d4ff800..2cb5c695e8 100644 --- a/doc/src/Python_atoms.rst +++ b/doc/src/Python_atoms.rst @@ -58,7 +58,7 @@ against invalid accesses. Each element of this list is a :py:class:`Atom ` or :py:class:`Atom2D ` object. The attributes of these objects provide access to their data (id, type, position, velocity, force, etc.): - .. code-block:: Python + .. code-block:: python # access first atom L.atoms[0].id @@ -71,7 +71,7 @@ against invalid accesses. Some attributes can be changed: - .. code-block:: Python + .. code-block:: python # set position in 2D simulation L.atoms[0].position = (1.0, 0.0) diff --git a/doc/src/Python_config.rst b/doc/src/Python_config.rst index 38f0ef0baf..ccbc74a46c 100644 --- a/doc/src/Python_config.rst +++ b/doc/src/Python_config.rst @@ -4,7 +4,7 @@ Configuration information The following methods can be used to query the LAMMPS library about compile time settings and included packages and styles. -.. code-block:: Python +.. code-block:: python :caption: Example for using configuration settings functions from lammps import lammps diff --git a/doc/src/Python_create.rst b/doc/src/Python_create.rst index ec4241f36a..939aad2f32 100644 --- a/doc/src/Python_create.rst +++ b/doc/src/Python_create.rst @@ -74,7 +74,7 @@ Here are simple examples using all three Python interfaces: :py:class:`PyLammps ` objects can also be created on top of an existing :py:class:`lammps ` object: - .. code-block:: Python + .. code-block:: python from lammps import lammps, PyLammps ... @@ -113,7 +113,7 @@ Here are simple examples using all three Python interfaces: You can also initialize IPyLammps on top of an existing :py:class:`lammps` or :py:class:`PyLammps` object: - .. code-block:: Python + .. code-block:: python from lammps import lammps, IPyLammps ... @@ -142,7 +142,7 @@ the MPI and/or Kokkos environment if enabled and active. Note that you can create multiple LAMMPS objects in your Python script, and coordinate and run multiple simulations, e.g. -.. code-block:: Python +.. code-block:: python from lammps import lammps lmp1 = lammps() diff --git a/doc/src/Python_error.rst b/doc/src/Python_error.rst index 744a8dd3de..5dbd940723 100644 --- a/doc/src/Python_error.rst +++ b/doc/src/Python_error.rst @@ -7,7 +7,7 @@ current Python process with an error message. C++ exceptions allow capturing them on the C++ side and rethrowing them on the Python side. This way LAMMPS errors can be handled through the Python exception handling mechanism. -.. code-block:: Python +.. code-block:: python from lammps import lammps, MPIAbortException diff --git a/doc/src/Python_execute.rst b/doc/src/Python_execute.rst index 59faa34438..01cf0e920f 100644 --- a/doc/src/Python_execute.rst +++ b/doc/src/Python_execute.rst @@ -60,7 +60,7 @@ it is possible to "compute" what the next LAMMPS command should be. can be executed using with the lammps API with the following Python code if ``lmp`` is an instance of :py:class:`lammps `: - .. code-block:: Python + .. code-block:: python from lammps import lammps @@ -73,7 +73,7 @@ it is possible to "compute" what the next LAMMPS command should be. The arguments of the command can be passed as one string, or individually. - .. code-block:: Python + .. code-block:: python from lammps import PyLammps @@ -93,14 +93,14 @@ it is possible to "compute" what the next LAMMPS command should be. parameterization. In the lammps API parameterization needed to be done manually by creating formatted command strings. - .. code-block:: Python + .. code-block:: python lmp.command("region box block %f %f %f %f %f %f" % (xlo, xhi, ylo, yhi, zlo, zhi)) In contrast, methods of PyLammps accept parameters directly and will convert them automatically to a final command string. - .. code-block:: Python + .. code-block:: python L.region("box block", xlo, xhi, ylo, yhi, zlo, zhi) diff --git a/doc/src/Python_launch.rst b/doc/src/Python_launch.rst index 500a107977..96e43a2d95 100644 --- a/doc/src/Python_launch.rst +++ b/doc/src/Python_launch.rst @@ -56,7 +56,7 @@ and you should see the same output as if you had typed Note that without the mpi4py specific lines from ``test.py`` -.. code-block:: Python +.. code-block:: python from lammps import lammps lmp = lammps() diff --git a/doc/src/Python_objects.rst b/doc/src/Python_objects.rst index 4a1496632e..6e3a329a27 100644 --- a/doc/src/Python_objects.rst +++ b/doc/src/Python_objects.rst @@ -76,7 +76,7 @@ computes, fixes, or variables in LAMMPS using the :py:mod:`lammps` module. To define a variable you can use the :doc:`variable ` command: - .. code-block:: Python + .. code-block:: python L.variable("a index 2") @@ -85,14 +85,14 @@ computes, fixes, or variables in LAMMPS using the :py:mod:`lammps` module. you can access an individual variable by retrieving a variable object from the ``L.variables`` dictionary by name - .. code-block:: Python + .. code-block:: python a = L.variables['a'] The variable value can then be easily read and written by accessing the value property of this object. - .. code-block:: Python + .. code-block:: python print(a.value) a.value = 4 diff --git a/doc/src/Python_properties.rst b/doc/src/Python_properties.rst index 02af03bbb8..227a729622 100644 --- a/doc/src/Python_properties.rst +++ b/doc/src/Python_properties.rst @@ -105,7 +105,7 @@ against invalid accesses. variables, compute or fix data (see :doc:`Howto_output`): - .. code-block:: Python + .. code-block:: python result = L.eval("ke") # kinetic energy result = L.eval("pe") # potential energy diff --git a/doc/src/Python_scatter.rst b/doc/src/Python_scatter.rst index 113b98d354..002a36cc98 100644 --- a/doc/src/Python_scatter.rst +++ b/doc/src/Python_scatter.rst @@ -1,7 +1,7 @@ Scatter/gather operations ========================= -.. code-block:: Python +.. code-block:: python data = lmp.gather_atoms(name,type,count) # return per-atom property of all atoms gathered into data, ordered by atom ID # name = "x", "charge", "type", etc @@ -42,7 +42,7 @@ For the scatter methods, the array of coordinates passed to must be a ctypes vector of ints or doubles, allocated and initialized something like this: -.. code-block:: Python +.. code-block:: python from ctypes import c_double natoms = lmp.get_natoms()