hmcmathematics / codee-class

LaTeX document class for typesetting submissions to the CODEE Journal.
LaTeX Project Public License v1.3c
1 stars 1 forks source link

codee-class: A LaTeX Document Class for the Community of Ordinary Differential Equations Educators (CODEE)

The Community of Ordinary Differential Equations Educators (CODEE) exists to improve the teaching and learning of ordinary differential equations (ODEs), primarily by encouraging broader use of modeling projects and computer experiments. CODEE publishes an electronic journal containing learning materials relating to ODEs called the CODEE Journal. This journal is published online at the CODEE Digital Library, accessible at http://www.codee.org/.

The LaTeX class, codee.cls, provides the basic formatting for a submission to the CODEE Journal. Included with the class is the how-to-prepare-manuscripts.tex document and its typeset version, how-to-prepare-manuscripts.pdf, which provide examples and additional information about writing CODEE submissions.

Getting the Document Class File

You can get a copy of the latest version of the class and supporting materials by going to the releases page and downloading the latest release listed there, which is currently Version 2.0.

Archives are available as Zip or tar.gz files.

Alternatively, you can clone this GitHub repository (click on the green "Clone or download" button on the right side of the page).

(We're also looking at making the code available through CTAN/TeX Live.)

Installing and Using the Document Class File

As with any LaTeX document class or style package, you can use the codee.cls file in any of several ways.

The easiest is to copy codee.cls into a directory and create your .tex file there, calling the class with

\documentclass{codee}

A better way is to install it in your own TEXMF tree, or, if you're installing it on a shared system, in a "local" TEXMF tree. The location of these trees is dependent on the particular TeX System you're using, as well as any local customizations you or a system administrator may have done. For examples, see MikTeX (Windows) or TeX Live (Windows, Mac OS X, Linux).

"A Directory Structure for TeX Files" provides more information about the structure of TEXMF trees. For the codee.cls file, all you need is a set of directories like TEXMFROOT/tex/latex/codee (i.e., once you figure out where your local or personal TEXMF tree lives, you can make sure it has a latex folder inside a tex folder, go there (e.g., with cd on a Mac or Linux system), and unpack the tar.gz or Zip archive you downloaded.

License

The CODEE LaTeX class and accompanying materials listed in manifest.txt are copyright by the Community of Ordinary Differential Equations Educators and licensed under the LaTeX Project Public License (LPPL), version 1.3c or later.

Contact & Support Information

The LaTeX class is developed by and supported by the CODEE project, on the web at http://www.codee.org/. There you will find contact information for the project.

This GitHub project, at https://github.com/hmcmathematics/codee-class/, is the master repository for the document class. If you find issues with the class's functionality, wish to request new features, or want to help by fixing bugs or writing code, please file an issue/pull request on GitHub.