-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfpm.toml
More file actions
425 lines (356 loc) · 16 KB
/
fpm.toml
File metadata and controls
425 lines (356 loc) · 16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
# This is your fpm(Fortran Package Manager) manifest file
# ("fpm.toml"). It is heavily annotated to help guide you though
# customizing a package build, although the defaults are sufficient
# for many basic packages.
#
# The manifest file is not only used to provide metadata identifying
# your project (so it can be used by others as a dependency). It can
# specify where your library and program sources live, what the name
# of the executable(s) will be, what files to build, dependencies on
# other fpm packages, and what external libraries are required.
#
# The manifest format must conform to the TOML configuration file
# standard.
#
# TOML files support flexible use of white-space and commenting of the
# configuration data, but for clarity in this sample active directives
# begin in column one. Inactive example directives are commented
# out with a pound character ("#") but begin in column one as well.
# Commentary begins with a pound character in column three.
#
# This file draws heavily upon the following references:
#
# The fpm home page at
# https://github.com/fortran-lang/fpm
# A complete list of keys and their attributes at
# https://github.com/fortran-lang/fpm/blob/main/manifest-reference.md
# examples of fpm project packaging at
# https://github.com/fortran-lang/fpm/blob/main/PACKAGING.md
# The Fortran TOML file interface and it's references at
# https://github.com/toml-f/toml-f
#
#-----------------------
# project Identification
#-----------------------
# We begin with project metadata at the manifest root. This data is designed
# to aid others when searching for the project in a repository and to
# identify how and when to contact the package supporters.
name = "CFDFortran"
# The project name (required) is how the project will be referred to.
# The name is used by other packages using it as a dependency. It also
# is used as the default name of any library built and the optional
# default executable built from app/main.f90. It must conform to the rules
# for a Fortran variable name.
version = "0.1.0"
# The project version number is a string. A recommended scheme for
# specifying versions is the Semantic Versioning scheme.
license = "license"
# Licensing information specified using SPDX identifiers is preferred
# (eg. "Apache-2.0 OR MIT" or "LGPL-3.0-or-later").
maintainer = "jane.doe@example.com"
# Information on the project maintainer and means to reach out to them.
author = "Jane Doe"
# Information on the project author.
copyright = "Copyright 2020 Jane Doe"
# A statement clarifying the Copyright status of the project.
#description = "A short project summary in plain text"
# The description provides a short summary on the project. It should be
# plain text and not use any markup formatting.
#categories = ["fortran", "graphics"]
# Categories associated with the project. Listing only one is preferred.
#keywords = ["hdf5", "mpi"]
# The keywords field is an array of strings describing the project.
#homepage = "https://stdlib.fortran-lang.org"
# URL to the webpage of the project.
# -----------------------------------------
# We are done with identifying the project.
# -----------------------------------------
#
# Now lets start describing how the project should be built.
#
# Note tables would go here but we will not be talking about them (much)!!
#
# Tables are a way to explicitly specify large numbers of programs in
# a compact format instead of individual per-program entries in the
# [[executable]], [[test]], and [[example]] sections to follow but
# will not be discussed further except for the following notes:
#
# + Tables must appear (here) before any sections are declared. Once a
# section is specified in a TOML file everything afterwards must be
# values for that section or the beginning of a new section. A simple
# example looks like:
#executable = [
# { name = "a-prog" },
# { name = "app-tool", source-dir = "tool" },
# { name = "fpm-man", source-dir = "tool", main="fman.f90" }
#]
# This would be in lieue of the [[executable]] section found later in this
# configuration file.
# + See the reference documents (at the beginning of this document)
# for more information on tables if you have long lists of programs
# to build and are not simply depending on auto-detection.
#
# Now lets begin the TOML sections (lines beginning with "[") ...
#
[install] # Options for the "install" subcommand
# When you run the "install" subcommand only executables are installed by
# default on the local system. Library projects that will be used outside of
# "fpm" can set the "library" boolean to also allow installing the module
# files and library archive. Without this being set to "true" an "install"
# subcommand ignores parameters that specify library installation.
# If your project sets `[library] type = "shared"`, enabling this option
# will install the compiled `.so`, `.dylib`, or `.dll` files into the
# appropriate `lib/` folder. This applies equally to static archives.
#
# For shared libraries, installing is typically required for runtime usage.
library = false
[build] # General Build Options
### Automatic target discovery
#
# Normally fpm recursively searches the app/, example/, and test/ directories
# for program sources and builds them. To disable this automatic discovery of
# program targets set the following to "false":
#auto-executables = true
#auto-examples = true
#auto-tests = true
### Package-level External Library Links
#
# To declare link-time dependencies on external libraries a list of
# native libraries can be specified with the "link" entry. You may
# have one library name or a list of strings in case several
# libraries should be linked. This list of library dependencies is
# exported to dependent packages. You may have to alter your library
# search-path to ensure the libraries can be accessed. Typically,
# this is done with the LD_LIBRARY_PATH environment variable on ULS
# (Unix-Like Systems). You only specify the core name of the library
# (as is typical with most programming environments, where you
# would specify "-lz" on your load command to link against the zlib
# compression library even though the library file would typically be
# a file called "libz.a" "or libz.so"). So to link against that library
# you would specify:
#link = "z"
# Note that in some cases the order of the libraries matters:
#link = ["blas", "lapack"]
[library]
# You can change the name of the directory to search for your library
# source from the default of "src/". Library targets are exported
# and usable by other projects.
source-dir="src"
# this can be a list:
#source-dir=["src", "src2"]
# More complex libraries may organize their modules in subdirectories.
# For modules in a top-level directory fpm requires (but does not
# enforce) that:
#
# + The module has the same name as the source file. This is important.
# + There should be only one module per file.
#
# These two requirements simplify the build process for fpm. As Fortran
# compilers emit module files (.mod) with the same name as the module
# itself (but not the source file, .f90), naming the module the same
# as the source file allows fpm to:
#
# + Uniquely and exactly map a source file (.f90) to its object (.o)
# and module (.mod) files.
# + Avoid conflicts with modules of the same name that could appear
# in dependency packages.
#
### Multi-level library source
# You can place your module source files in any number of levels of
# subdirectories inside your source directory, but there are certain naming
# conventions to be followed -- module names must contain the path components
# of the directory that its source file is in.
#
# This rule applies generally to any number of nested directories and
# modules. For example, src/a/b/c/d.f90 must define a module called a_b_c_d.
# Again, this is not enforced but may be required in future releases.
### Library type
# Set `type = "shared"` to build dynamic libraries (.so/.dylib/.dll)
# instead of a static archive. You can also set `type = "static"` to
# generate per-package archives, or use `type = "monolithic"` (default)
# to bundle all sources and dependencies into a single archive.
#
# Supported types:
#
# + "monolithic": Single archive with used sources and dependencies.
# + "static": One full archive per package (for external integration).
# + "shared": One shared library per package, for dynamic linking.
#
# Shared libraries are useful for plugin systems, dynamic linking, or
# language bindings. Static per-package archives may aid external reuse.
#
# When running with `fpm run`, shared library paths are automatically
# added to the environment (e.g. `LD_LIBRARY_PATH`, `PATH`) at runtime.
#
# Note: library files are not installed unless `[install] library=true`
# is also enabled.
#
# Example:
type = "static"
[dependencies]
# Inevitably, you will want to be able to include other packages in
# a project. Fpm makes this incredibly simple, by taking care of
# fetching and compiling your dependencies for you. You just tell it
# what your dependencies names are, and where to find them.
#
# If you are going to distribute your package only place dependencies
# here someone using your package as a remote dependency needs built.
# You can define dependencies just for developer executables in the
# next section, or even for specific executables as we will see below
# (Then fpm will still fetch and compile it when building your
# developer executables, but users of your library will not have to).
#
## GLOBAL DEPENDENCIES (exported with your project)
#
# Typically, dependencies are defined by specifying the project's
# git repository.
#
# You can be specific about which version of a dependency you would
# like. By default the latest default branch is used. You can
# optionally specify a branch, a tag or a commit value.
#
# So here are several alternates for specifying a remote dependency (you
# can have at most one of "branch", "rev" or "tag" present):
stdlib ={git = "https://github.com/fortran-lang/stdlib.git", branch = "stdlib-fpm" }
fortplot = { git = "https://github.com/krystophny/fortplot" }#stdlib = {git="https://github.com/LKedward/stdlib-fpm.git",branch = "master" },
#stdlib = {git="https://github.com/LKedward/stdlib-fpm.git", tag = "v0.1.0" },
#stdlib = {git="https://github.com/LKedward/stdlib-fpm.git", rev = "5a9b7a8" }.
# There may be multiple packages listed:
#M_strings = { git = "https://github.com/urbanjost/M_strings.git" }
#M_time = { git = "https://github.com/urbanjost/M_time.git" }
#
# You can even specify the local path to another project if it is in
# a sub-folder (If for example you have got another fpm package **in
# the same repository**) like this:
#M_strings = { path = "M_strings" }
# This tells fpm that we depend on a crate called M_strings which is found
# in the M_strings folder (relative to the fpm.toml it’s written in).
#
# For a more verbose layout use normal tables rather than inline tables
# to specify dependencies:
#[dependencies.toml-f]
#git = "https://github.com/toml-f/toml-f"
#rev = "2f5eaba864ff630ba0c3791126a3f811b6e437f3"
# Now you can use any modules from these libraries anywhere in your
# code -- whether is in your library source or a program source.
[dev-dependencies]
## Dependencies Only for Development
#
# You can specify dependencies your library or application does not
# depend on in a similar way. The difference is that these will not
# be exported as part of your project to those using it as a remote
# dependency.
#
# Currently, like a global dependency it will still be available for
# all codes. It is up to the developer to ensure that nothing except
# developer test programs rely upon it.
#M_msg = { git = "https://github.com/urbanjost/M_msg.git" }
#M_verify = { git = "https://github.com/urbanjost/M_verify.git" }
#-----------------------------------
## Application-specific declarations
#-----------------------------------
# Now lets begin entries for the TOML tables (lines beginning with "[[")
# that describe the program sources -- applications, tests, and examples.
#
# First we will configuration individual applications run with "fpm run".
#
# + the "name" entry for the executable to be built must always
# be specified. The name must satisfy the rules for a Fortran
# variable name. This will be the name of the binary installed by
# the "install" subcommand and used on the "run" subcommand.
# + The source directory for each executable can be adjusted by the
# "source-dir" entry.
# + The basename of the source file containing the program body can
# be specified with the "main" entry.
# + Executables can also specify their own external package and
# library link dependencies.
#
# Currently, like a global dependency any external package dependency
# will be available for all codes. It is up to the developer to ensure
# that nothing except the application programs specified rely upon it.
#
# Note if your application needs to use a module internally, but you do not
# intend to build it as a library to be used in other projects, you can
# include the module in your program source file or directory as well.
[[executable]]
name="step_0"
source-dir="app"
main="step_0.f90"
[[executable]]
name="step_1"
source-dir="app"
main="step_1.f90"
[[executable]]
name="step_2"
source-dir="app"
main="step_2.f90"
[[executable]]
name="step_3"
source-dir="app"
main="step_3.f90"
[[executable]]
name="step_4"
source-dir="app"
main="step_4.f90"
[[executable]]
name="step_5"
source-dir="app"
main="step_5.f90"
# You may repeat this pattern to define additional applications. For instance,
# the following sample illustrates all accepted options, where "link" and
# "executable.dependencies" keys are the same as the global external library
# links and package dependencies described previously except they apply
# only to this executable:
#[[ executable ]]
#name = "app-name"
#source-dir = "prog"
#main = "program.f90"
#link = "z"
#[executable.dependencies]
#M_CLI = { git = "https://github.com/urbanjost/M_CLI.git" }
#helloff = { git = "https://gitlab.com/everythingfunctional/helloff.git" }
#M_path = { git = "https://github.com/urbanjost/M_path.git" }
[[test]]
# The same declarations can be made for test programs, which are
# executed with the "fpm test" command and are not build when your
# package is used as a dependency by other packages. These are
# typically unit tests of the package only used during package
# development.
name="runTests"
source-dir="test"
main="check.f90"
# you may repeat this pattern to add additional explicit test program
# parameters. The following example contains a sample of all accepted
# options.
#[[ test ]]
#name = "tester"
#source-dir="test"
#main="tester.f90"
#link = ["blas", "lapack"]
#[test.dependencies]
#M_CLI2 = { git = "https://github.com/urbanjost/M_CLI2.git" }
#M_io = { git = "https://github.com/urbanjost/M_io.git" }
#M_system= { git = "https://github.com/urbanjost/M_system.git" }
# [[example]]
# # Example applications for a project are defined here.
# # These are run via "fpm run --example NAME" and like the
# # test applications, are not built when this package is used as a
# # dependency by other packages.
# name="lesson_0"
# source-dir="example"
# main="00_Quick_Fortran_Intro.f90"
# [[example]]
# name="step_1"
# source-dir="example"
# main="01_Step_1.f90"
#
# you may add additional programs to the example table. The following
# example contains a sample of all accepted options
#[[ example ]]
#name = "example-tool"
#source-dir="example"
#main="tool.f90"
#link = "z"
#[example.dependencies]
#M_kracken95 = { git = "https://github.com/urbanjost/M_kracken95.git" }
#datetime = {git = "https://github.com/wavebitscientific/datetime-fortran.git" }