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 dpCtl to dpctl in all comments, license headers, and docs. #342

Merged
merged 1 commit into from
Mar 31, 2021
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
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ We use [clang-format](https://clang.llvm.org/docs/ClangFormat.html) code formatt
Install: `conda install clang-tools`

- Revision: `10.0.1`
- See the default configuration used by dpCtl in `.clang-format`.
- See the default configuration used by dpctl in `.clang-format`.

Run before each commit: `clang-format -style=file -i dpctl-capi/include/*.h dpctl-capi/include/Support/*.h dpctl-capi/source/*.cpp dpctl-capi/tests/*.cpp dpctl-capi/helper/include/*.h dpctl-capi/helper/source/*.cpp`

Expand All @@ -30,7 +30,7 @@ purpose of the file. The standard header looks like this:
```
//===----- dpctl_sycl_event_interface.h - C API for sycl::event -*-C++-*- ===//
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand Down Expand Up @@ -69,7 +69,7 @@ Few things to note about this format:
Every Python and Cython file should only include the following license header:

```
# Data Parallel Control (dpCtl)
# Data Parallel Control (dpctl)
#
# Copyright 2020-2021 Intel Corporation
#
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ conda install dpctl

Build and Install with setuptools
=================================
dpCtl relies on DPC++ runtime. With Intel oneAPI installed you should activate it.
dpctl relies on DPC++ runtime. With Intel oneAPI installed you should activate it.
`setup.py` requires environment variable `ONEAPI_ROOT` and following packages
installed:
- `cython`
Expand All @@ -67,11 +67,11 @@ python setup.py develop

Install Wheel Package from Pypi
==================================
1. Install dpCtl
1. Install dpctl
```cmd
python -m pip install --index-url https://pypi.anaconda.org/intel/simple -extra-index-url https://pypi.org/simple dpctl
```
Note: dpCtl wheel package is placed on Pypi, but some of its dependencies (like Intel numpy) are in Anaconda Cloud.
Note: dpctl wheel package is placed on Pypi, but some of its dependencies (like Intel numpy) are in Anaconda Cloud.
That is why install command requires additional intel Pypi channel from Anaconda Cloud.

2. Set path to Performance Libraries in case of using venv or system Python:
Expand All @@ -84,9 +84,9 @@ On Windows:
set PATH=<path_to_your_env>\bin;<path_to_your_env>\Library\bin;%PATH%
```

Using dpCtl
Using dpctl
===========
dpCtl relies on DPC++ runtime. With Intel oneAPI installed you could activate it.
dpctl relies on DPC++ runtime. With Intel oneAPI installed you could activate it.

On Windows:
```cmd
Expand All @@ -97,7 +97,7 @@ On Linux:
source ${ONEAPI_ROOT}/compiler/latest/env/vars.sh
```

When dpCtl is installed via conda package
When dpctl is installed via conda package
then it uses DPC++ runtime from `dpcpp_cpp_rt` package
and it is not necessary to activate oneAPI DPC++ compiler environment.

Expand All @@ -113,7 +113,7 @@ for script in `ls examples/python/`; do echo "executing ${script}"; python examp
```

Examples of building Cython extensions with DPC++ compiler, that interoperate
with dpCtl can be found in folder `cython`.
with dpctl can be found in folder `cython`.

Each example in `cython` folder can be built using
`CC=clang CXX=dpcpp python setup.py build_ext --inplace`.
Expand Down
2 changes: 1 addition & 1 deletion conda-recipe/meta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ test:
- pytest
- pytest-cov
about:
home: https://github.com/IntelPython/dpCtl.git
home: https://github.com/IntelPython/dpctl.git
license: Apache-2.0
license_file: LICENSE
summary: 'A lightweight Python wrapper for a subset of OpenCL and SYCL API.'
Expand Down
6 changes: 3 additions & 3 deletions docs/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
cmake_minimum_required(VERSION 3.18 FATAL_ERROR)
project("Data-parallel Control (dpCtl)")
project("Data-parallel Control (dpctl)")
# Add the cmake folder so the FindSphinx module is found
set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})

Expand All @@ -9,7 +9,7 @@ find_package (Git)

set(DOC_OUTPUT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/generated_docs)
if( DPCTL_DOCGEN_PREFIX )
message(STATUS "Generating dpCtl documents in " ${DPCTL_DOCGEN_PREFIX})
message(STATUS "Generating dpctl documents in " ${DPCTL_DOCGEN_PREFIX})
set(DOC_OUTPUT_DIR ${DPCTL_DOCGEN_PREFIX})
endif()

Expand Down Expand Up @@ -74,7 +74,7 @@ add_custom_command(
COMMAND
${SPHINX_EXECUTABLE} -b html
# Tell Breathe where to find the Doxygen output
-Dbreathe_projects.dpCtl-CAPI=${DOXYGEN_OUTPUT_DIR}/xml
-Dbreathe_projects.dpctl-CAPI=${DOXYGEN_OUTPUT_DIR}/xml
${SPHINX_SOURCE} ${SPHINX_OUTPUT_DIR}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
DEPENDS
Expand Down
2 changes: 1 addition & 1 deletion docs/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = "Data-parallel Control (dpCtl)"
PROJECT_NAME = "Data-parallel Control (dpctl)"

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
What?
=====

Generator scripts for dpCtl API documentation. To run these scripts, follow
Generator scripts for dpctl API documentation. To run these scripts, follow
the following steps:
```bash
cd dpctl/docs
Expand All @@ -16,7 +16,7 @@ documents in the current source directory in a sub-directory called
`generated_docs`.

The `make Sphinx` command will generate standalone Doxygen documentation and
a consolidated Sphinx documentation for both dpCtl Python and C APIs.
a consolidated Sphinx documentation for both dpctl Python and C APIs.

Prerequisite
============
Expand Down
6 changes: 3 additions & 3 deletions docs/conf.in
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ extensions = [
]

# Breathe Configuration
breathe_default_project = "dpCtl-CAPI"
breathe_default_project = "dpctl-CAPI"

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand All @@ -58,8 +58,8 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
exhale_args = {
# These arguments are required
"containmentFolder": "./api",
"rootFileName": "dpCtl-CAPI_root.rst",
"rootFileTitle": "dpCtl C API",
"rootFileName": "dpctl-CAPI_root.rst",
"rootFileTitle": "dpctl C API",
"doxygenStripFromPath": "..",
"createTreeView": True,
"exhaleExecutesDoxygen": True,
Expand Down
2 changes: 1 addition & 1 deletion docs/dpCtl.dptensor_api.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _dpCtl.dptensor_api:

#########################
dpCtl dptensor Python API
dpctl dptensor Python API
#########################

.. automodule:: dpctl.dptensor
Expand Down
2 changes: 1 addition & 1 deletion docs/dpCtl.program_api.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _dpCtl.program_api:

########################
dpCtl Program Python API
dpctl Program Python API
########################

.. automodule:: dpctl.program
Expand Down
2 changes: 1 addition & 1 deletion docs/dpCtl_api.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _dpCtl_api:

################
dpCtl Python API
dpctl Python API
################

.. automodule:: dpctl
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to Data-parallel Control (dpCtl)'s documentation!
Welcome to Data-parallel Control (dpctl)'s documentation!
=========================================================

.. toctree::
Expand Down
4 changes: 2 additions & 2 deletions dpctl-capi/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
cmake_minimum_required(VERSION 3.10 FATAL_ERROR)
project("dpCtl C API - A C wrapper for a subset of SYCL")
project("dpctl C API - A C wrapper for a subset of SYCL")

# Option to turn on support for creating Level Zero interoperability programs
# from a SPIR-V binary file.
Expand Down Expand Up @@ -152,7 +152,7 @@ if(DPCTL_GENERATE_COVERAGE)
endif()
endif()

# Add sub-directory to build the dpCtl C API test cases
# Add sub-directory to build the dpctl C API test cases
if(DPCTL_BUILD_CAPI_TESTS)
add_subdirectory(tests)
endif()
2 changes: 1 addition & 1 deletion dpctl-capi/cmake/modules/FindDPCPP.cmake
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Data Parallel Control (dpCtl)
# Data Parallel Control (dpctl)
#
# Copyright 2020-2021 Intel Corporation
#
Expand Down
2 changes: 1 addition & 1 deletion dpctl-capi/cmake/modules/FindLcov.cmake
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Data Parallel Control (dpCtl)
# Data Parallel Control (dpctl)
#
# Copyright 2020-2021 Intel Corporation
#
Expand Down
2 changes: 1 addition & 1 deletion dpctl-capi/cmake/modules/FindLevelZero.cmake
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Data Parallel Control (dpCtl)
# Data Parallel Control (dpctl)
#
# Copyright 2020-2021 Intel Corporation
#
Expand Down
2 changes: 1 addition & 1 deletion dpctl-capi/helper/include/dpctl_async_error_handler.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//===-- dpctl_async_error_handler.h - An async error handler -*-C++-*- ===//
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand Down
2 changes: 1 addition & 1 deletion dpctl-capi/helper/include/dpctl_dynamic_lib_helper.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//===--- dpctl_dynamic_lib_helper.h - Dynamic library helper -*-C++-*- ===//
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand Down
4 changes: 2 additions & 2 deletions dpctl-capi/helper/include/dpctl_utils_helper.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//===-- dpctl_utils.h - Enum to string helper functions -*-C++-*- ===//
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand All @@ -19,7 +19,7 @@
//===----------------------------------------------------------------------===//
///
/// \file
/// This file defines common helper functions used in other places in dpCtl.
/// This file defines common helper functions used in other places in dpctl.
//===----------------------------------------------------------------------===//

#pragma once
Expand Down
2 changes: 1 addition & 1 deletion dpctl-capi/helper/include/dpctl_vector_macros.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//=== dpctl_vector_macros.h - Macros to help build function sig. -*-C++-*- //
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand Down
2 changes: 1 addition & 1 deletion dpctl-capi/helper/source/dpctl_async_error_handler.cpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//===-- dpctl_async_error_handler.h - An async error handler -*-C++-*- ===//
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand Down
2 changes: 1 addition & 1 deletion dpctl-capi/helper/source/dpctl_utils_helper.cpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//===- dpctl_utils_helper.cpp - Implementation of enum to string helpers ===//
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand Down
10 changes: 5 additions & 5 deletions dpctl-capi/include/Config/dpctl_config.h.in
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//===--------- dpctl_config.h - Configured options for dpCtl C API ===//
//===--------- dpctl_config.h - Configured options for dpctl C API ===//
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand All @@ -19,14 +19,14 @@
//===----------------------------------------------------------------------===//
///
/// \file
/// This file exports a set of dpCtl C API configurations.
/// This file exports a set of dpctl C API configurations.
///
//===----------------------------------------------------------------------===//

#pragma once

/* Defined when dpCtl was built with level zero program creation enabled. */
/* Defined when dpctl was built with level zero program creation enabled. */
#cmakedefine DPCTL_ENABLE_LO_PROGRAM_CREATION @DPCTL_ENABLE_LO_PROGRAM_CREATION@

/* The DPCPP version used to build dpCtl */
/* The DPCPP version used to build dpctl */
#define DPCTL_DPCPP_VERSION "@DPCPP_VERSION@"
4 changes: 2 additions & 2 deletions dpctl-capi/include/Support/CBindingWrapping.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//===- CBindingWrapping.h - Wrappers for casting C pointers -*-C++-*- ===//
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand All @@ -19,7 +19,7 @@
//===----------------------------------------------------------------------===//
///
/// \file
/// This file declares the wrapping macros for the dpCtl C interface.
/// This file declares the wrapping macros for the dpctl C interface.
///
//===----------------------------------------------------------------------===//

Expand Down
2 changes: 1 addition & 1 deletion dpctl-capi/include/Support/DllExport.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//===--------- DllExport.h - Decalres dllexport for Windows -*-C++-*- ===//
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand Down
2 changes: 1 addition & 1 deletion dpctl-capi/include/Support/ExternC.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//===----------- ExternC.h - Defines an extern C helper macro -*-C++-*- ===//
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand Down
4 changes: 2 additions & 2 deletions dpctl-capi/include/Support/MemOwnershipAttrs.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//===- MemOwnershipAttrs.h - Defines memory ownership attributes -*-C++-*- ===//
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand All @@ -22,7 +22,7 @@
/// This file defines a group of macros that serve as attributes indicating the
/// type of ownership of a pointer. The macros are modeled after similar
/// attributes defines in Integer Set Library (isl) and serve the purpose of
/// helping a programmer understand the semantics of a dpCtl function.
/// helping a programmer understand the semantics of a dpctl function.
///
//===----------------------------------------------------------------------===//

Expand Down
2 changes: 1 addition & 1 deletion dpctl-capi/include/dpctl_data_types.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//===-------------- dpctl_data_types.h - Defines integer types -*-C++-*- ===//
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand Down
2 changes: 1 addition & 1 deletion dpctl-capi/include/dpctl_error_handler_type.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//===--- dpctl_error_handler_types.h - Error handler callbacks -*-C++-*- ===//
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand Down
2 changes: 1 addition & 1 deletion dpctl-capi/include/dpctl_sycl_context_interface.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//===-- dpctl_sycl_context_interface.h - C API for sycl::context -*-C++-*- ===//
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand Down
2 changes: 1 addition & 1 deletion dpctl-capi/include/dpctl_sycl_device_interface.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//===----- dpctl_sycl_device_interface.h - C API for sycl::device -*-C++-*- ==//
//
// Data Parallel Control (dpCtl)
// Data Parallel Control (dpctl)
//
// Copyright 2020-2021 Intel Corporation
//
Expand Down
Loading