Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename to csv-fortran #38

Merged
merged 1 commit into from
Nov 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ jobs:

- name: Build documentation
if: contains( matrix.gcc_v, 10 )
run: ford ./fortran-csv-module.md
run: ford ./ford.md

- name: Deploy Documentation
if: contains( matrix.gcc_v, 10 ) && github.ref == 'refs/heads/master'
Expand Down
28 changes: 14 additions & 14 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ cmake_policy(SET CMP0053 NEW)
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")

# Set package metadata
set(CPACK_PACKAGE_NAME "fortran-csv-module")
set(CPACK_PACKAGE_NAME "csv-fortran")
set(CPACK_PACKAGE_VERSION_MAJOR "1")
set(CPACK_PACKAGE_VERSION_MINOR "3")
set(CPACK_PACKAGE_VERSION_PATCH "1")
Expand All @@ -18,7 +18,7 @@ set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "A modern Fortran library for reading and
# set(CPACK_PACKAGE_VENDOR "")
set(CPACK_PACKAGE_CONTACT "Jacob Williams")
set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/README.md")
set(CPACK_PACKAGE_HOMEPAGE_URL "https://github.com/jacobwilliams/fortran-csv-module")
set(CPACK_PACKAGE_HOMEPAGE_URL "https://github.com/jacobwilliams/csv-fortran")
# See https://spdx.org/licenses/
set(SPDX_LICENSE_TAG "BSD-3-Clause")
set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
Expand All @@ -34,7 +34,7 @@ string(TIMESTAMP BUILD_TIMESTAMP UTC)
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

# Set project name and language
project(fortran-csv-module
project(csv-fortran
LANGUAGES Fortran
VERSION "${CPACK_PACKAGE_VERSION}")

Expand Down Expand Up @@ -94,9 +94,9 @@ if(${FC_ALLOWS_NO_OPTIMIZATION})
list(APPEND FCOPTS ${FCOPT_NO_OPTIMIZATION})
endif()

message(STATUS "Fortran compiler options for fortran-csv-module set to ${FCOPTS}")
message(STATUS "Fortran compiler options for csv-fortran set to ${FCOPTS}")

# Target FCSV: fortran-csv-module library
# Target FCSV: csv-fortran library
set(FCSV_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/src")

# Define sources for FCSV library
Expand Down Expand Up @@ -126,7 +126,7 @@ install(TARGETS ${LIBFCSV_NAME})

### Test executables

# Target : fortran-csv-module library
# Target : csv-fortran library
set(TEST_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/src/tests")

# add_executable(csv_write_test "${TEST_SOURCE_DIR}/csv_write_test.f90")
Expand Down Expand Up @@ -312,8 +312,8 @@ if(WIN32)
# Set up NSIS
find_package(NSIS)
if(NSIS_FOUND)
# set(CPACK_NSIS_MUI_ICON "${CMAKE_CURRENT_SOURCE_DIR}/img/fortran-csv-module-icon.ico")
# set(CPACK_NSIS_MUI_UNIICON "${CMAKE_CURRENT_SOURCE_DIR}/img/fortran-csv-module-icon.ico")
# set(CPACK_NSIS_MUI_ICON "${CMAKE_CURRENT_SOURCE_DIR}/img/csv-fortran-icon.ico")
# set(CPACK_NSIS_MUI_UNIICON "${CMAKE_CURRENT_SOURCE_DIR}/img/csv-fortran-icon.ico")
set(CPACK_NSIS_INSTALLED_ICON_NAME "Uninstall.exe")
set(CPACK_NSIS_HELP_LINK "${CPACK_PACKAGE_HOMEPAGE_URL}")
set(CPACK_NSIS_URL_INFO_ABOUT "${CPACK_PACKAGE_HOMEPAGE_URL}")
Expand All @@ -332,7 +332,7 @@ if(WIN32)
RENAME LICENSE.txt
DESTINATION doc)

# install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/img/fortran-csv-module-icon.png"
# install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/img/csv-fortran-icon.png"
# DESTINATION img)

# set(CPACK_NUGET_COMPONENT_INSTALL OFF)
Expand All @@ -345,12 +345,12 @@ if(WIN32)
set(CPACK_NUGET_PACKAGE_HOMEPAGE_URL "${CPACK_PACKAGE_HOMEPAGE_URL}")
# LicenseURL is deprecated; how to set License with CMake/CPack?
# set(CPACK_NUGET_PACKAGE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
# set(CPACK_NUGET_PACKAGE_LICENSEURL "https://github.com/jacobwilliams/fortran-csv-module/blob/master/LICENSE")
# set(CPACK_NUGET_PACKAGE_LICENSEURL "https://github.com/jacobwilliams/csv-fortran/blob/master/LICENSE")
set(CPACK_NUGET_PACKAGE_LICENSE_EXPRESSION "${SPDX_LICENSE_TAG}")
# set(CPACK_NUGET_PACKAGE_LICENSE_FILE_NAME "doc/LICENSE.txt")
# A URL for a 64x64 image with transparency background to use as the icon for the package in UI display.
# set(CPACK_NUGET_PACKAGE_ICONURL "https://example.com/img/fortran-csv-module-icon.png")
# set(CPACK_NUGET_PACKAGE_ICON "img/fortran-csv-module-icon.png")
# set(CPACK_NUGET_PACKAGE_ICONURL "https://example.com/img/csv-fortran-icon.png")
# set(CPACK_NUGET_PACKAGE_ICON "img/csv-fortran-icon.png")
set(CPACK_NUGET_PACKAGE_DESCRIPTION_SUMMARY "${CPACK_PACKAGE_DESCRIPTION_SUMMARY}")
set(CPACK_NUGET_PACKAGE_RELEASE_NOTES "Experimental version for testing NuGet packaging. For information only.")
set(CPACK_NUGET_PACKAGE_COPYRIGHT "Copyright 2021, Jacob Williams")
Expand All @@ -359,7 +359,7 @@ if(WIN32)
set(CPACK_NUGET_PACKAGE_TAGS "CSV" "comma separated values" "Fortran")
# # Repository info
# set(CPACK_NUGET_PACKAGE_REPOSITORY_TYPE "git")
# set(CPACK_NUGET_PACKAGE_REPOSITORY_URL "https://github.com/jacobwilliams/fortran-csv-module.git")
# set(CPACK_NUGET_PACKAGE_REPOSITORY_URL "https://github.com/jacobwilliams/csv-fortran.git")
# set(CPACK_NUGET_PACKAGE_REPOSITORY_BRANCH "1.2.1")
# set(CPACK_NUGET_PACKAGE_REPOSITORY_COMMIT "77a50e78c52<your_hash_here>7bba3bd655b4400b")
# A list of package dependencies.
Expand All @@ -385,7 +385,7 @@ if(WIN32)
set(WIX_LICENSE_FILE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE.rtf")
set(CPACK_WIX_LICENSE_RTF "${WIX_LICENSE_FILE}")
install(FILES "${WIX_LICENSE_FILE}" DESTINATION doc)
# set(CPACK_WIX_PRODUCT_ICON "${CMAKE_CURRENT_SOURCE_DIR}/img/fortran-csv-module-icon.ico")
# set(CPACK_WIX_PRODUCT_ICON "${CMAKE_CURRENT_SOURCE_DIR}/img/csv-fortran-icon.ico")

list(APPEND CPACK_GENERATOR WIX)
else()
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Fortran CSV Module
https://github.com/jacobwilliams/fortran-csv-module
https://github.com/jacobwilliams/csv-fortran

Copyright (c) 2017-2022, Jacob Williams
All rights reserved.
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
![fortran-csv-module](media/logo.png)
![csv-fortran](media/logo.png)
============

[![Language](https://img.shields.io/badge/-Fortran-734f96?logo=fortran&logoColor=white)](https://github.com/topics/fortran)
[![GitHub release](https://img.shields.io/github/release/jacobwilliams/fortran-csv-module.svg)](https://github.com/jacobwilliams/fortran-csv-module/releases/latest)
[![Build Status](https://github.com/jacobwilliams/fortran-csv-module/actions/workflows/CI.yml/badge.svg)](https://github.com/jacobwilliams/fortran-csv-module/actions)
[![codecov](https://codecov.io/gh/jacobwilliams/fortran-csv-module/branch/master/graph/badge.svg?token=43HK33CSMY)](https://codecov.io/gh/jacobwilliams/fortran-csv-module)
[![last-commit](https://img.shields.io/github/last-commit/jacobwilliams/fortran-csv-module)](https://github.com/jacobwilliams/fortran-csv-module/commits/master)
[![GitHub release](https://img.shields.io/github/release/jacobwilliams/csv-fortran.svg)](https://github.com/jacobwilliams/csv-fortran/releases/latest)
[![Build Status](https://github.com/jacobwilliams/csv-fortran/actions/workflows/CI.yml/badge.svg)](https://github.com/jacobwilliams/csv-fortran/actions)
[![codecov](https://codecov.io/gh/jacobwilliams/csv-fortran/branch/master/graph/badge.svg?token=43HK33CSMY)](https://codecov.io/gh/jacobwilliams/csv-fortran)
[![last-commit](https://img.shields.io/github/last-commit/jacobwilliams/csv-fortran)](https://github.com/jacobwilliams/csv-fortran/commits/master)

### Description

A modern Fortran library for reading and writing CSV (comma-separated value) files.

### Latest Release

[![GitHub release](https://img.shields.io/github/release/jacobwilliams/fortran-csv-module.svg?style=plastic)](https://github.com/jacobwilliams/fortran-csv-module/releases/latest)
[![GitHub release](https://img.shields.io/github/release/jacobwilliams/csv-fortran.svg?style=plastic)](https://github.com/jacobwilliams/csv-fortran/releases/latest)

### Documentation

The latest API documentation for the `master` branch can be found [here](https://jacobwilliams.github.io/fortran-csv-module/). This was generated from the source code using [FORD](https://github.com/Fortran-FOSS-Programmers/ford).
The latest API documentation for the `master` branch can be found [here](https://jacobwilliams.github.io/csv-fortran/). This was generated from the source code using [FORD](https://github.com/Fortran-FOSS-Programmers/ford).


### Getting started
#### Get the code
```bash
git clone https://github.com/jacobwilliams/fortran-csv-module
cd fortran-csv-module
git clone https://github.com/jacobwilliams/csv-fortran
cd csv-fortran
```
#### Dependencies
1. Git
Expand All @@ -37,10 +37,10 @@ You can build using provided `fpm.toml`:
```bash
fpm build
```
To use `fortran-csv-module` within your fpm project, add the following to your `fpm.toml` file:
To use `csv-fortran` within your fpm project, add the following to your `fpm.toml` file:
```toml
[dependencies]
fortran-csv-module = { git="https://github.com/jacobwilliams/fortran-csv-module.git" }
csv-fortran = { git="https://github.com/jacobwilliams/csv-fortran.git" }
```

### Examples
Expand Down Expand Up @@ -131,4 +131,4 @@ Various options are user-selectable for specifying the format (e.g., changing th

### License

This library is released under a [BSD-3 license](https://github.com/jacobwilliams/fortran-csv-module/blob/master/LICENSE).
This library is released under a [BSD-3 license](https://github.com/jacobwilliams/csv-fortran/blob/master/LICENSE).
12 changes: 6 additions & 6 deletions contrib/cmake/BuildFCSV.cmake
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
if(GIT_FOUND)
# Retrieve, build, and install fortran-csv-module (aka FCSV)
# Retrieve, build, and install csv-fortran (aka FCSV)
# distribution from GitHub
set(FCSV_DIST_DIR "${CMAKE_CURRENT_BINARY_DIR}/FCSV-source")

Expand All @@ -15,9 +15,9 @@ if(GIT_FOUND)
# Note: Use URL and URL_HASH [SHA512|SHA256|MD5]=4A54C0DE... to
# download and checksum an archive. Note that URL may refer to a
# local file, allowing this to work without net access.
# GIT_REPOSITORY https://github.com/jacobwilliams/fortran-csv-module.git
# GIT_REPOSITORY https://github.com/jacobwilliams/csv-fortran.git
# GIT_TAG 1.2.0
GIT_REPOSITORY https://github.com/jacobwilliams/fortran-csv-module
GIT_REPOSITORY https://github.com/jacobwilliams/csv-fortran
GIT_TAG 1.3.1
SOURCE_DIR "${FCSV_DIST_DIR}"
INSTALL_DIR "${FCSV_LOCAL_INSTALL_DIR}"
Expand All @@ -28,7 +28,7 @@ if(GIT_FOUND)
USES_TERMINAL_UPDATE YES
)

# From fortran-csv-module/CMakeLists.txt:
# From csv-fortran/CMakeLists.txt:
# ...
# # Set default installation paths; should be invoked after setting project language(s)
# include(GNUInstallDirs)
Expand All @@ -39,7 +39,7 @@ if(GIT_FOUND)
# ...

# Create ${FCSV_LOCAL_INSTALL_DIR}/finclude based on the module install location
# set in fortran-csv-module/CMakeLists.txt. Creating this directory avoids a race
# set in csv-fortran/CMakeLists.txt. Creating this directory avoids a race
# condition - see https://www.scivision.dev/cmake-fetchcontent-vs-external-project/
file(MAKE_DIRECTORY ${FCSV_LOCAL_INSTALL_DIR}/finclude)

Expand Down Expand Up @@ -76,7 +76,7 @@ if(GIT_FOUND)
else()
message(STATUS "git not available; using fallback CSV source files")

set(FCSV_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/contrib/fortran-csv-module/src")
set(FCSV_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/contrib/csv-fortran/src")

# Full path to csv_kinds.f90
set(FCSV_KINDS_SRC "${FCSV_SOURCE_DIR}/csv_kinds.f90")
Expand Down
6 changes: 3 additions & 3 deletions contrib/cmake/IncludeFCSV.cmake
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Retrieve fortran-csv-module from external source and include into project
# See https://github.com/jacobwilliams/fortran-csv-module
# Retrieve csv-fortran from external source and include into project
# See https://github.com/jacobwilliams/csv-fortran
#
#!!! Verify all these!
# The following output variables are set by the FCSV subproject
Expand All @@ -10,7 +10,7 @@ set(FCSV_SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}/FCSV-source")

FetchContent_Declare(
FCSV_external
GIT_REPOSITORY https://github.com/jacobwilliams/fortran-csv-module.git
GIT_REPOSITORY https://github.com/jacobwilliams/csv-fortran.git
GIT_TAG 1.3.1
SOURCE_DIR "${FCSV_SOURCE_DIR}"
)
Expand Down
10 changes: 5 additions & 5 deletions contrib/cmake/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Contributed CMake Support

The following CMake recipes are intended for developers using
fortran-csv-module as a dependency in their own projects.
csv-fortran as a dependency in their own projects.

Please read through the recipes before use; they contain
documentation that will help integrate fortran-csv-module
documentation that will help integrate csv-fortran
with a CMake based project.

Each recipe has advantages and disadvantages as listed below.
Expand All @@ -17,7 +17,7 @@ to pulling source code over the network or vice versa.
FindFCSV searches the host system for a previously installed fcsv library
(*e.g.* `libfcsv.a`) and the Fortran module file `csv_module.mod`.
No version checking is performed and there will likely be problems
if fortran-csv-module and the parent project are built with
if csv-fortran and the parent project are built with
different Fortran compilers.

## BuildFCSV.cmake
Expand All @@ -27,7 +27,7 @@ use; they currently point to a test fork of the library. Also, ensure that
`include(Git)` and `include(ExternalProject)` are called in the parent
project before this recipe.

This recipe uses `ExternalProject_Add` to retrieve the fortran-csv-module
This recipe uses `ExternalProject_Add` to retrieve the csv-fortran
project and build it as an standalone dependency of the parent
project. Tests and compiler flags of FCSV are kept separate from the
parent project.
Expand All @@ -39,7 +39,7 @@ use; they currently point to a test fork of the library. Also, ensure that
`include(Git)` and `include(FetchContent)` are called in the parent
project before this recipe.

This recipe uses `FetchContent` to retrieve the fortran-csv-module
This recipe uses `FetchContent` to retrieve the csv-fortran
project and build it as part of the parent project. This has two
important effects: compiler flags of the parent and child project
are merged and CTest will run FCSV's tests in addition to those of
Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions fortran-csv-module.md → ford.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
project: fortran-csv-module
project: csv-fortran
project_dir: ./src
output_dir: ./doc
media_dir: ./media
project_github: https://github.com/jacobwilliams/fortran-csv-module
project_github: https://github.com/jacobwilliams/csv-fortran
summary: Read and Write CSV Files Using Modern Fortran
author: Jacob Williams
github: https://github.com/jacobwilliams
Expand Down
4 changes: 2 additions & 2 deletions fpm.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name = "fortran-csv-module"
name = "csv-fortran"
version = "2.0.1"
author = "Jacob Williams"
maintainer = "Jacob Williams"
copyright = "Copyright (c) 2017-2023, Jacob Williams"
license = "BSD-3"
description = "Read and Write CSV Files Using Modern Fortran"
homepage = "https://github.com/jacobwilliams/fortran-csv-module"
homepage = "https://github.com/jacobwilliams/csv-fortran"
categories = ["io"]
keywords = ["csv"]

Expand Down