source commit: ac9f0e6

Author: actions-user

CODE_OF_CONDUCT.md

@@ -0,0 +1,12 @@
+---
+title: "Contributor Code of Conduct"
+---
+
+As contributors and maintainers of this project,
+we pledge to follow the [The Carpentries Code of Conduct][coc].
+
+Instances of abusive, harassing, or otherwise unacceptable behavior
+may be reported by following our [reporting guidelines][coc-reporting].
+
+[coc-reporting]: https://docs.carpentries.org/topic_folders/policies/incident-reporting.html
+[coc]: https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html

LICENSE.md

@@ -0,0 +1,79 @@
+---
+title: "Licenses"
+---
+
+## Instructional Material
+
+All Carpentries (Software Carpentry, Data Carpentry, and Library Carpentry)
+instructional material is made available under the [Creative Commons
+Attribution license][cc-by-human]. The following is a human-readable summary of
+(and not a substitute for) the [full legal text of the CC BY 4.0
+license][cc-by-legal].
+
+You are free:
+
+- to **Share**---copy and redistribute the material in any medium or format
+- to **Adapt**---remix, transform, and build upon the material
+
+for any purpose, even commercially.
+
+The licensor cannot revoke these freedoms as long as you follow the license
+terms.
+
+Under the following terms:
+
+- **Attribution**---You must give appropriate credit (mentioning that your work
+  is derived from work that is Copyright (c) The Carpentries and, where
+  practical, linking to <https://carpentries.org/>), provide a [link to the
+  license][cc-by-human], and indicate if changes were made. You may do so in
+  any reasonable manner, but not in any way that suggests the licensor endorses
+  you or your use.
+
+- **No additional restrictions**---You may not apply legal terms or
+  technological measures that legally restrict others from doing anything the
+  license permits. With the understanding that:
+
+Notices:
+
+- You do not have to comply with the license for elements of the material in
+  the public domain or where your use is permitted by an applicable exception
+  or limitation.
+- No warranties are given. The license may not give you all of the permissions
+  necessary for your intended use. For example, other rights such as publicity,
+  privacy, or moral rights may limit how you use the material.
+
+## Software
+
+Except where otherwise noted, the example programs and other software provided
+by The Carpentries are made available under the [OSI][osi]-approved [MIT
+license][mit-license].
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+## Trademark
+
+"The Carpentries", "Software Carpentry", "Data Carpentry", and "Library
+Carpentry" and their respective logos are registered trademarks of [Community
+Initiatives][ci].
+
+[cc-by-human]: https://creativecommons.org/licenses/by/4.0/
+[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
+[mit-license]: https://opensource.org/licenses/mit-license.html
+[ci]: https://communityin.org/
+[osi]: https://opensource.org

data/exercises.tar.gz

@@ -0,0 +1,65 @@
+---
+site: sandpaper::sandpaper_site
+---
+
+::: caution
+
+This is a new lesson built with [The Carpentries Workbench][carpentries-workbench].
+It is currently in pre-alpha development by the
+[British Geological Survey][bgs-link],
+the [National Centre for Atmospheric Science][ncas-link],
+the [National Oceanography Centre][noc-link],
+and the [Met Office][uk-met-link].
+
+The lesson adapts resources from
+[ARCHER2](https://github.com/ARCHER2-HPC/archer2-fortran-intro),
+[Imperial College London](https://github.com/ImperialCollegeLondon/RCDS-introduction-to-fortran),
+[Modern Fortran in Science and Technology course](https://github.com/jonaslindemann/modern_fortran_book?tab=readme-ov-file),
+[LRZ's Programming with Fortran course](https://doku.lrz.de/programming-with-fortran-10746212.html),
+and more.[^other-courses]
+
+:::
+
+Fortran was created in 1957 by a team at IBM
+and excels with numerically intensive science code.
+Far from the punchcards, and fixed-form formatting of Fortran's early days,
+modern Fortran is fast, supports object orientated programming
+and is easy to read.
+
+Fortran is often used to write code for High Performance Computing (HPC).
+Many of the research codes run on ARCHER2[^archer2]
+are Fortran programs.[^archer2-codes]
+Various areas of Science are covered by these Fortran programs.
+For example quantum chemistry, plasmas, and numerical weather prediction.
+
+More recent standards of Fortran come under the umbrella term "Modern Fortran".
+These are the Fortran 95 standard,
+and more recent standards.[^fortran-standards]
+
+::::::::::::::::::::::::::::::::::::: prereq
+
+### Prerequisites
+
+Learners _should_ be familiar with the basic concepts of
+programming: variables, logic, control flow, loops, functions and
+so on.
+No knowledge of Fortran is assumed.
+No previous experience with compiled languages is required.
+Access to the command line is required.
+Learners _must_ be comfortable using the command line[^command-line].
+
+::::::::::::::::::::::::::::::::::::::::::::
+
+This lesson has been tested primarily on Linux.
+Windows users may find it easier to install
+[Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install).
+With WSL you will have access to a Linux command line.
+Windows and macOS users should open an
+[Issue](https://github.com/carpentries-incubator/intro-to-modern-fortran/issues)
+if you find problems with the lesson material.
+
+[^other-courses]: Discussion #3 on the lesson repository, https://github.com/carpentries-incubator/intro-to-modern-fortran/discussions/3, give details on the materials this course draws from.
+[^archer2]: ARCHER2, https://www.archer2.ac.uk/, is one of the UKs national supercomputing facilities.
+[^archer2-codes]: ARCHER2 code use article: https://www.archer2.ac.uk/news/2021/05/19/code-use.html
+[^fortran-standards]: Fortran standards page on the Fortran Wiki: https://fortranwiki.org/fortran/show/Standards
+[^command-line]: Learners should be comfortable with the Carpentries Unix Shell lesson material: https://swcarpentry.github.io/shell-novice/

index.md

@@ -0,0 +1,15 @@
+---
+title: Instructor Notes
+---
+
+## Learner Profiles
+
+Before teaching a workshop consider who is attending and their needs. This section highlights audiences for this Fortran course. Instructors can use the profiles to decide which episodes to teach or place more emphasis on.
+
+**_Tahani is a new research software engineer at the Met Office._** She has just joined the office after their degree and have experience in Python, Linux, and shell commands. She has limited experience with compiled languages. The weather and climate code she will be working on is written in Fortran. She thought Fortran was a dead language.
+
+**_Ionas, a researcher joining the JULES (Joint UK Land Environment Simulator) partnership._** They will be adding new functionality to JULES in Fortran. They have extensive experience with C and C++ and have been told there are differences between Fortran and C/C++ that they should be aware of. They are keen to learn Fortran but must fit their learning inbetween teaching duties and other research commitments.
+
+**_Malak is mathematics graduate student working on new timestepping methods._** Malaks previous work was mostly theoretical although he knows basic Python. Malak needs to use Fortran to prototype his new routines which will interface with other Fortran code. Malak has been told by his supervisor that he should set up his preferred text editor for Fortran development.
+
+**_Joe has been employed by a tech company to update their Fortran code._** Joe has years of experience developing mainly C++ code for HPCs but has not used Fortran in a production environment. They have been asked to update legacy code to modern standards, including implementing some form of testing and using standard libraries. Joe is not sure if there is a standard code style that they can adopt.

instructor-notes.md

@@ -0,0 +1,220 @@
+---
+title: 'Introduction'
+teaching: 10
+exercises: 10
+---
+
+::::::::::::::::::::::::::::::::::::: questions
+
+- What is Fortran?
+
+::::::::::::::::::::::::::::::::::::::::::::::::
+
+::::::::::::::::::::::::::::::::::::: objectives
+
+- Understand some of Fortrans colourful history
+
+::::::::::::::::::::::::::::::::::::::::::::::::
+
+## Introduction
+A very simple program might be:
+
+```fortran
+program example1
+
+  ! An example program prints "Hello World" to the screen
+
+  print * , "Hello World"
+
+end program example1
+```
+
+Formally, a Fortran program consists of one or more lines made up of
+Fortran _statements_. Line breaks are significant (e.g., there are
+no semi-colons `;` required here).
+
+Comments are introduced with an exclamation mark `!`, and may trail
+other statements.
+
+The `program` statement is roughly doing the equivalent job of `main()`
+in C/C++. However, note there is not (and must not be) a return statement.
+
+::::::::::::::::::::::::::::::::::::: challenge
+
+## Compiling your first program
+
+Check now you can compile and run the first example program `example1.f90`.
+
+:::::::::::::::: solution
+
+Using `ftn`:
+
+```shell
+$ something something something
+```
+
+:::::::::::::::::::::::::
+:::::::::::::::::::::::::::::::::::::::::::::::
+
+### Formal description
+
+```
+  [ program [program-name] ]
+     [ specification-part ]
+     [ exectuable-part ]
+  [ contains
+     internal-subprogram-part ]
+  end [program-name]
+```
+
+Optional components are represented with square brackets `[...]`. It
+follows that the shortest standard-conforming program will be (see
+`example2.f90`):
+
+```fortran
+end
+```
+
+If the `program-name` is present, it must be at both the beginning and
+the end, and must be the same in both places.
+
+We will return to the `contains` statement in the context of modules.
+
+## `print` statement
+
+In general
+
+```fortran
+  print format [ , output-item-list ]
+```
+
+where the `format` is a format specifier (discussed later) and the
+`output-item-list` is a comma-separated list of values/variables
+to be printed to the standard output.
+
+If the format is a  `*` (a so-called free-format) the implementation
+is allowed to apply a default format for a given type of item.
+
+
+## Alternative
+
+Consider the following program (available as `example3.f90`):
+
+```fortran
+program example3
+
+  use iso_fortran_env, only : output_unit
+
+  write (output_unit, *) "Hello ", "world"
+
+end program example3
+```
+
+This example shows a more general way to provide some output. Here we are
+also going to employ the `use` statement to import a symbol from the
+(intrinsic) module `iso_fortran_env`. The symbol is `output_unit` which
+identifies the default standard output (cf. `stdout`).
+
+
+### `use` statement
+
+Formally,
+
+```fortran
+  use [[ , module-nature] ::] module-name [ , only : [only-list]]
+```
+
+If `module-nature` is present, it must be either `intrinsic` or
+`non_intrinsic`. The implementation must provide certain intrinsic
+modules such `iso_fortran_env`.
+
+There is no formal namespace mechanism in Fortran (cf. C++), so
+restrictions on which symbols are visible can be made via an optional
+`only-list`. If there is no `only-list` then all the public symbols
+from `module-name` will be visible.
+
+
+### `write` statement
+
+Formally,
+
+```fortran
+  write (io-control-spec-list) [output-item-list]
+```
+
+where the `output-item-list` is a comma separated list of items to
+be output. The `io-control-spec-list` has a large number of potential
+arguments (again comma separated). For formatted output, these must
+include at least a unit number and a format:
+
+```fortran
+  write ([unit = ] io-unit, [fmt = ] format) [output-item-list]
+```
+
+where the `io-unit` is a valid integer unit number, and the `format`
+is a format-specifier (as for `print`).
+
+Examples are
+
+```fortran
+  write (unit = output_unit, fmt = *)
+  write (output_unit, *)
+  write (*, *)
+```
+
+C programmers looking for a new-line like symbol will notice that none
+has appeared so far. The default situation is that both `print` and
+`write` generate a new-line automatically. The `*` symbol in the context
+of `io-unit` is a default output unit (usually the screen).
+
+We will return to the `write` statement and format-specifiers in more
+detail in the context of i/o to external files.
+
+## Some comments on style
+
+Modern Fortran is not case sensitive. Older versions required capitals,
+a style which has persisted to the present day in some places. So you
+may see things such as
+
+```fortran
+PROGRAM example1
+
+  PRINT *, "Hello World"
+
+END PROGRAM example1
+```
+
+As modern etiquette tends to regard capitals as shouting, this can cause
+some strain. In addition, as the compiler will accept mixed
+case, an additional tool would be required to enforce style (if
+enforcement was wanted).
+
+This course therefore prefers an all lower-case style.
+
+::::::::::::::::::::::::::::::::::::: challenge
+
+## Writing your first program
+
+Write a program which prints out the actual values of the symbols
+`output_unit`, `error_unit`, and `input_unit`
+(all from `iso_fortran_env`) to the screen.
+
+If you haven't used the `only` clause in your `use iso_fortran_env`,
+add it now. What happens to the results if you miss out one of the
+symbols referenced from the `only` clause? This behaviour will be
+explained in the following section.
+
+:::::::::::::::: solution
+
+A version of this program is available as `exercise1.f90`.
+
+:::::::::::::::::::::::::
+:::::::::::::::::::::::::::::::::::::::::::::::
+
+::::::::::::::::::::::::::::::::::::: keypoints 
+
+- A Fortran program is made up of one or more _statements_ which are separated by line breaks
+- Comments are declared with an `!` and may trail other statements
+
+::::::::::::::::::::::::::::::::::::::::::::::::
+