Skip to content

Commit

Permalink
Merge pull request #35 from open-space-collective/users/lucas/rename-…
Browse files Browse the repository at this point in the history
…project

Rename project
  • Loading branch information
lucas-bremond authored Jan 5, 2020
2 parents 58dd938 + c1ab323 commit 86dd327
Show file tree
Hide file tree
Showing 191 changed files with 4,371 additions and 4,375 deletions.
2 changes: 1 addition & 1 deletion .codecov.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
################################################################################################################################################################

# @project Library ▸ Mathematics
# @project Open Space Toolkit ▸ Mathematics
# @file .codecov.yml
# @author Lucas Brémond <[email protected]>
# @license Apache License 2.0
Expand Down
4 changes: 2 additions & 2 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "Library Mathematics",
"name": "Open Space Toolkit Mathematics",
"extensions": [
"ms-vscode.cpptools",
"ms-python.python",
"mhutchie.git-graph"
],
"image": "openspacecollective/library-mathematics-development:latest-debian",
"image": "openspacecollective/open-space-toolkit-mathematics-development:latest-debian",
"settings": {
"terminal.integrated.shell.linux": "/bin/bash"
},
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
################################################################################################################################################################

# @project Library ▸ Mathematics
# @project Open Space Toolkit ▸ Mathematics
# @file .gitignore
# @author Lucas Brémond <[email protected]>
# @license Apache License 2.0
Expand Down Expand Up @@ -54,5 +54,6 @@ docs/latex/
tmp/
__pycache__
.ipynb_checkpoints
.pytest_cache/

################################################################################################################################################################
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
################################################################################################################################################################

# @project Library ▸ Mathematics
# @project Open Space Toolkit ▸ Mathematics
# @file .travis.yml
# @author Lucas Brémond <[email protected]>
# @license Apache License 2.0
Expand Down
20 changes: 10 additions & 10 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
################################################################################################################################################################

# @project Library ▸ Mathematics
# @project Open Space Toolkit ▸ Mathematics
# @file CMakeLists.txt
# @author Lucas Brémond <[email protected]>
# @license Apache License 2.0
Expand All @@ -9,10 +9,10 @@

## Project Properties

SET (PROJECT_NAME "LibraryMathematics")
SET (PROJECT_NAME "OpenSpaceToolkitMathematics")
SET (PROJECT_DESCRIPTION "Mathematics library.")
SET (PROJECT_PATH "Library/Mathematics")
SET (PROJECT_PACKAGE_NAME "library-mathematics")
SET (PROJECT_PATH "OpenSpaceToolkit/Mathematics")
SET (PROJECT_PACKAGE_NAME "open-space-toolkit-mathematics")
SET (PROJECT_LICENSE "Apache License 2.0")
SET (PROJECT_VENDOR_ID "org.open-space-collective")
SET (PROJECT_VENDOR_NAME "Open Space Collective")
Expand Down Expand Up @@ -260,13 +260,13 @@ ENDIF ()

# INCLUDE_DIRECTORIES ("/usr/local/include/Gte")

### Library ▸ Core [0.2.x]
### Open Space Toolkit ▸ Core [0.2.x]

FIND_PACKAGE ("LibraryCore" "0.2" REQUIRED)
FIND_PACKAGE ("OpenSpaceToolkitCore" "0.2" REQUIRED)

IF (NOT LibraryCore_FOUND)
IF (NOT OpenSpaceToolkitCore_FOUND)

MESSAGE (SEND_ERROR "[Library ▸ Core] not found.")
MESSAGE (SEND_ERROR "[Open Space Toolkit ▸ Core] not found.")

ENDIF ()

Expand Down Expand Up @@ -305,7 +305,7 @@ IF (BUILD_SHARED_LIBRARY)

TARGET_LINK_LIBRARIES (${SHARED_LIBRARY_TARGET} "pthread")
TARGET_LINK_LIBRARIES (${SHARED_LIBRARY_TARGET} "Boost::date_time" "Boost::filesystem" "Boost::log")
TARGET_LINK_LIBRARIES (${SHARED_LIBRARY_TARGET} ${LibraryCore_LIBRARIES})
TARGET_LINK_LIBRARIES (${SHARED_LIBRARY_TARGET} ${OpenSpaceToolkitCore_LIBRARIES})

SET_TARGET_PROPERTIES (${SHARED_LIBRARY_TARGET} PROPERTIES VERSION ${PROJECT_VERSION_STRING} SOVERSION ${PROJECT_VERSION_MAJOR} OUTPUT_NAME ${SHARED_LIBRARY_NAME} CLEAN_DIRECT_OUTPUT 1 INSTALL_RPATH "$ORIGIN/../lib:$ORIGIN/")

Expand All @@ -331,7 +331,7 @@ IF (BUILD_STATIC_LIBRARY)

TARGET_LINK_LIBRARIES (${STATIC_LIBRARY_TARGET} "pthread")
TARGET_LINK_LIBRARIES (${STATIC_LIBRARY_TARGET} "Boost::date_time" "Boost::filesystem" "Boost::log")
TARGET_LINK_LIBRARIES (${STATIC_LIBRARY_TARGET} ${LibraryCore_LIBRARIES})
TARGET_LINK_LIBRARIES (${STATIC_LIBRARY_TARGET} ${OpenSpaceToolkitCore_LIBRARIES})


SET_TARGET_PROPERTIES (${STATIC_LIBRARY_TARGET} PROPERTIES VERSION ${PROJECT_VERSION_STRING} OUTPUT_NAME ${SHARED_LIBRARY_NAME} CLEAN_DIRECT_OUTPUT 1 INSTALL_RPATH "$ORIGIN/../lib:$ORIGIN/")
Expand Down
29 changes: 14 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,26 @@
Contributing
============
# Contributing

*⚠ This document is a work in progress.*

[TOC]

# Introduction {#Introduction}
## Introduction {#Introduction}

*To be completed...*

# Guidelines {#Guidelines}
## Guidelines {#Guidelines}

## Codebase {#Codebase}
### Codebase {#Codebase}

### C++ {#C}
#### C++ {#C}

Include order from specific to generic:

```cpp
#include <Library/Astrodynamics/Orbit.hpp>
#include <OpenSpaceToolkit/Astrodynamics/Orbit.hpp>

#include <Library/Core/Types/Integer.hpp>
#include <Library/Core/Utilities.hpp>
#include <OpenSpaceToolkit/Core/Types/Integer.hpp>
#include <OpenSpaceToolkit/Core/Utilities.hpp>

#include <map>
#include <string>
Expand All @@ -32,17 +31,17 @@ References:
- https://stackoverflow.com/questions/2762568/c-c-include-file-order-best-practices
- https://blog.kowalczyk.info/article/qg/order-of-include-headers-in-cc.html

### Python {#Python}
#### Python {#Python}

*To be completed...*

## Version Control {#Version}
### Version Control {#Version}

### Rules {#Rules}
#### Rules {#Rules}

*To be completed...*

### Commit Messages {#Commit}
#### Commit Messages {#Commit}

[How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/)

Expand All @@ -64,6 +63,6 @@ Examples:
[fix] Segmentation fault when fetching ephemeris data
```

# Code of Conduct {#CodeOfConduct}
## Code of Conduct {#CodeOfConduct}

*To be completed...*
*To be completed...*
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
################################################################################################################################################################

# @project Library ▸ Mathematics
# @project Open Space Toolkit ▸ Mathematics
# @file Makefile
# @author Lucas Brémond <[email protected]>
# @license Apache License 2.0

################################################################################################################################################################

export project_name := library-mathematics
export project_name := open-space-toolkit-mathematics
export project_version := $(shell git describe --tags --always)
export project_directory := $(shell git rev-parse --show-toplevel)

Expand All @@ -24,7 +24,7 @@ export docker_jupyter_notebook_image_repository := $(docker_image_repository)-ju
export jupyter_notebook_image_repository := jupyter/scipy-notebook:latest
export jupyter_notebook_port := 9003

export library_core_directory := $(project_directory)/../library-core
export open_space_toolkit_core_directory := $(project_directory)/../open-space-toolkit-core

export ci_build_number := $(TRAVIS_BUILD_NUMBER)
export ci_commit := $(TRAVIS_COMMIT)
Expand Down Expand Up @@ -459,7 +459,7 @@ _test-unit-python: _build-release-image-python

docker run \
--rm \
--workdir=/usr/local/lib/python3.7/site-packages/Library/Mathematics \
--workdir=/usr/local/lib/python3.7/site-packages/ostk/mathematics \
--entrypoint="" \
$(docker_release_image_python_repository):$(docker_image_version)-$(target) \
/bin/bash -c "pip install pytest && pytest ."
Expand Down
28 changes: 11 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,17 @@
# Library ▸ Mathematics
# Open Space Toolkit ▸ Mathematics

Geometry, curve fitting, optimization.

[![Build Status](https://travis-ci.com/open-space-collective/library-mathematics.svg?branch=master)](https://travis-ci.com/open-space-collective/library-mathematics)
[![Code Coverage](https://codecov.io/gh/open-space-collective/library-mathematics/branch/master/graph/badge.svg)](https://codecov.io/gh/open-space-collective/library-mathematics)
[![Documentation](https://img.shields.io/readthedocs/pip/stable.svg)](https://open-space-collective.github.io/library-mathematics)
[![GitHub version](https://badge.fury.io/gh/open-space-collective%2Flibrary-mathematics.svg)](https://badge.fury.io/gh/open-space-collective%2Flibrary-mathematics)
[![PyPI version](https://badge.fury.io/py/LibraryMathematicsPy.svg)](https://badge.fury.io/py/LibraryMathematicsPy)
[![Build Status](https://travis-ci.com/open-space-collective/open-space-toolkit-mathematics.svg?branch=master)](https://travis-ci.com/open-space-collective/open-space-toolkit-mathematics)
[![Code Coverage](https://codecov.io/gh/open-space-collective/open-space-toolkit-mathematics/branch/master/graph/badge.svg)](https://codecov.io/gh/open-space-collective/open-space-toolkit-mathematics)
[![Documentation](https://img.shields.io/readthedocs/pip/stable.svg)](https://open-space-collective.github.io/open-space-toolkit-mathematics)
[![GitHub version](https://badge.fury.io/gh/open-space-collective%2Fopen-space-toolkit-mathematics.svg)](https://badge.fury.io/gh/open-space-collective%2Fopen-space-toolkit-mathematics)
[![PyPI version](https://badge.fury.io/py/open-space-toolkit-mathematics.svg)](https://badge.fury.io/py/open-space-toolkit-mathematics)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

## Warning

Library **name** is yet to be defined.

Please check the following projects:

- [Naming Project](https://github.com/orgs/open-space-collective/projects/1)

*⚠ This library is still under heavy development. Do not use!*
*⚠ This component is under development.*

## Structure

Expand Down Expand Up @@ -101,7 +95,7 @@ The **Mathematics** library exhibits the following structure:

Documentation is available here:

- [C++](https://open-space-collective.github.io/library-io)
- [C++](https://open-space-collective.github.io/open-space-toolkit-mathematics)
- [Python](./bindings/python/docs)

## Tutorials
Expand Down Expand Up @@ -171,7 +165,7 @@ make start-development

This will:

1. Build the `openspacecollective/library-mathematics-development` Docker image.
1. Build the `openspacecollective/open-space-toolkit-mathematics-development` Docker image.
2. Create a development environment container with local source files and helper scripts mounted.
3. Start a `bash` shell from the `./build` working directory.

Expand Down Expand Up @@ -200,7 +194,7 @@ make test
Or to run them manually:

```bash
./bin/library-mathematics.test
./bin/open-space-toolkit-mathematics.test
```

*Tip: `helpers/test.sh` simplifies running tests from within the development environment.*
Expand All @@ -212,7 +206,7 @@ Or to run them manually:
| Boost | 1.69.0 | Boost Software License | [boost.org](https://www.boost.org) |
| Eigen | 3.3.7 | MPL2 | [eigen.tuxfamily.org](http://eigen.tuxfamily.org/index.php) |
| Geometric Tools Engine | 3.28 | Boost Software License | [geometrictools.com](https://www.geometrictools.com) |
| Core | master | Apache License 2.0 | [github.com/open-space-collective/library-core](https://github.com/open-space-collective/library-core) |
| Core | master | Apache License 2.0 | [github.com/open-space-collective/open-space-toolkit-core](https://github.com/open-space-collective/open-space-toolkit-core) |

## Contribution

Expand Down
20 changes: 11 additions & 9 deletions bindings/python/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
################################################################################################################################################################

# @project Library ▸ Mathematics
# @project Open Space Toolkit ▸ Mathematics
# @file bindings/python/CMakeLists.txt
# @author Lucas Brémond <[email protected]>
# @license Apache License 2.0
Expand All @@ -9,10 +9,12 @@

## Project Properties

SET (PROJECT_NAME "LibraryMathematicsPy")
SET (PROJECT_DESCRIPTION "Python bindings for Library / Mathematics.")
SET (PROJECT_PACKAGE_NAME "LibraryMathematicsPy")
SET (PROJECT_PATH "Library/Mathematics")
SET (PROJECT_NAME "OpenSpaceToolkitMathematicsPy")
SET (PROJECT_DESCRIPTION "Python bindings for Open Space Toolkit / Mathematics.")
SET (PROJECT_PACKAGE_NAME "OpenSpaceToolkitMathematicsPy")
SET (PROJECT_GROUP "ostk")
SET (PROJECT_SUBGROUP "mathematics")
SET (PROJECT_PATH "${PROJECT_GROUP}/${PROJECT_SUBGROUP}")
SET (PROJECT_LICENSE "Apache License 2.0")
SET (PROJECT_VENDOR_ID "com.bremond.lucas")
SET (PROJECT_VENDOR_NAME "Lucas Brémond")
Expand Down Expand Up @@ -123,7 +125,7 @@ SET_TARGET_PROPERTIES ( ${LIBRARY_TARGET} PROPERTIES
INSTALL_RPATH "$ORIGIN/../lib:$ORIGIN/")

INSTALL (TARGETS ${LIBRARY_TARGET} DESTINATION "${INSTALL_LIB}/${PROJECT_PATH}" COMPONENT "python")
INSTALL (FILES "${PROJECT_SOURCE_DIR}/tools/python/Library/__init__.py" DESTINATION "${INSTALL_LIB}/Library" COMPONENT "python")
INSTALL (FILES "${PROJECT_SOURCE_DIR}/tools/python/${PROJECT_GROUP}/__init__.py" DESTINATION "${INSTALL_LIB}/${PROJECT_GROUP}" COMPONENT "python")
INSTALL (FILES "${PROJECT_SOURCE_DIR}/tools/python/${PROJECT_PATH}/__init__.py" DESTINATION "${INSTALL_LIB}/${PROJECT_PATH}" COMPONENT "python")

################################################################################################################################################################
Expand All @@ -149,12 +151,12 @@ CONFIGURE_FILE (${SETUP_PY_IN} ${SETUP_PY})
ADD_CUSTOM_COMMAND (OUTPUT ${OUTPUT}
COMMAND mkdir -p "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_PATH}"
COMMAND cp -r "${CMAKE_CURRENT_SOURCE_DIR}/test" "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_PATH}/test"
COMMAND cp "${CMAKE_CURRENT_SOURCE_DIR}/tools/python/Library/__init__.py" "${CMAKE_CURRENT_BINARY_DIR}/Library/__init__.py"
COMMAND cp "${CMAKE_CURRENT_SOURCE_DIR}/tools/python/${PROJECT_GROUP}/__init__.py" "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_GROUP}/__init__.py"
COMMAND cp "${CMAKE_CURRENT_SOURCE_DIR}/tools/python/${PROJECT_PATH}/__init__.py" "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_PATH}/__init__.py"
COMMAND cp "/usr/local/lib/libboost_${PYTHON_VERSION}.so.${BOOST_VERSION}.0" "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_PATH}/libboost_${PYTHON_VERSION}.so.${BOOST_VERSION}.0"
COMMAND cp "/usr/local/lib/libboost_numpy37.so.${BOOST_VERSION}.0" "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_PATH}/libboost_numpy37.so.${BOOST_VERSION}.0"
COMMAND cp "${CMAKE_SOURCE_DIR}/lib/${SHARED_LIBRARY_TARGET}" "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_PATH}/liblibrary-mathematics.so.0"
COMMAND cp "${CMAKE_SOURCE_DIR}/lib/${LIBRARY_TARGET}" "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_PATH}/LibraryMathematicsPy.so"
COMMAND cp "${CMAKE_SOURCE_DIR}/lib/${SHARED_LIBRARY_TARGET}" "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_PATH}/libopen-space-toolkit-mathematics.so.0"
COMMAND cp "${CMAKE_SOURCE_DIR}/lib/${LIBRARY_TARGET}" "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_PATH}/${LIBRARY_TARGET}"
COMMAND ${PYTHON} ${SETUP_PY} bdist_wheel
COMMAND ${CMAKE_COMMAND} -E touch ${OUTPUT}
DEPENDS ${DEPS})
Expand Down
14 changes: 7 additions & 7 deletions bindings/python/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Library ▸ MathematicsBindings ▸ Python
# Open Space ToolkitMathematics

Geometry, curve fitting, optimization.

[![Build Status](https://travis-ci.com/open-space-collective/library-mathematics.svg?branch=master)](https://travis-ci.com/open-space-collective/library-mathematics)
[![Code Coverage](https://codecov.io/gh/open-space-collective/library-mathematics/branch/master/graph/badge.svg)](https://codecov.io/gh/open-space-collective/library-mathematics)
[![Documentation](https://img.shields.io/readthedocs/pip/stable.svg)](https://open-space-collective.github.io/library-mathematics)
[![GitHub version](https://badge.fury.io/gh/open-space-collective%2Flibrary-mathematics.svg)](https://badge.fury.io/gh/open-space-collective%2Flibrary-mathematics)
[![PyPI version](https://badge.fury.io/py/LibraryMathematicsPy.svg)](https://badge.fury.io/py/LibraryMathematicsPy)
[![Build Status](https://travis-ci.com/open-space-collective/open-space-toolkit-mathematics.svg?branch=master)](https://travis-ci.com/open-space-collective/open-space-toolkit-mathematics)
[![Code Coverage](https://codecov.io/gh/open-space-collective/open-space-toolkit-mathematics/branch/master/graph/badge.svg)](https://codecov.io/gh/open-space-collective/open-space-toolkit-mathematics)
[![Documentation](https://img.shields.io/readthedocs/pip/stable.svg)](https://open-space-collective.github.io/open-space-toolkit-mathematics)
[![GitHub version](https://badge.fury.io/gh/open-space-collective%2Fopen-space-toolkit-mathematics.svg)](https://badge.fury.io/gh/open-space-collective%2Fopen-space-toolkit-mathematics)
[![PyPI version](https://badge.fury.io/py/open-space-toolkit-mathematics.svg)](https://badge.fury.io/py/open-space-toolkit-mathematics)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[Library ▸ Mathematics](https://github.com/open-space-collective/library-mathematics)
[GitHub](https://github.com/open-space-collective/open-space-toolkit-mathematics)
2 changes: 1 addition & 1 deletion bindings/python/docs/Reference.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Library ▸ Mathematics"
"# Open Space Toolkit ▸ Mathematics"
]
},
{
Expand Down
Loading

0 comments on commit 86dd327

Please sign in to comment.