Commit 747a43e1 authored by Oriol Martínez's avatar Oriol Martínez 🖥
Browse files

COMPSs 3.0

parent 1f36dbbc
The development of this software has been supported by the following institutions:
* Spanish Government under contracts SEV2015-0493 and TIN2015-65316.
* Generalitat de Catalunya under contract 2014-SGR-1051.
* European Commission's through the following R&D projects:
- FP6 CoreGrid Network of Excelence (Contract IST-2002-004265)
- FP7 Optimis Project (Contract 257115)
- FP7 Venus-C Project (Contract 261565)
- FP7 transPLANT (contract 283496)
- FP7 EUBrazilOpenBio (Contract 288754)
- FP7 Euroserver Project (Contract 610456)
- FP7 Ascetic Project (Contract 610874)
- FP7 Euroserver Project (Contract 610456)
- FP7 EUBrazilCC (Contract 614048)
- H2020 NextGenIO (Contract 671951)
- H2020 MuG Project (Contract 676556)
- H2020 TANGO Project (Contract 687584)
- H2020 EUBra-BIGSEA (Contract 690116)
- H2020 EXPERTISE European Training Network (Contract 721865)
- H2020 mf2c Project (Contract 730929)
- H2020 Landsupport Project (Contract 774234)
- H2020 CLASS Project (Contract 780622)
- H2020 ExaQute Project (Contract 800898)
- H2020 BioExcel Center of Excellence (Contracts 823830, and 675728)
# Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at support-compss@bsc.es. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
# Contributing to COMPSs
When contributing to this repository, please first discuss the change you wish to
make via issue, email, or any other method with the owners of this repository. Please,
do it before making a change.
Please note we have a code of conduct, please follow it in all your interactions
with the project.
## Pull Request Process
1. Ensure any install or build dependencies are removed before the end of the layer
when doing a build.
2. Update the README.md with details of changes to the interface, this includes new
environment variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new
version that this Pull Request would represent. The versioning scheme we use
is [SemVer][sem_version].
4. You may merge the Pull Request in once you have the sign-off of two other
developers, or if you do not have permission to do that, you may request the
second reviewer to merge it for you.
[sem_version]: http://semver.org/
ARG DEBIAN_FRONTEND=noninteractive
ARG BASE=base20
FROM compss/${BASE}_ci as ci
ENV GRADLE_HOME /opt/gradle
ENV JAVA_HOME /usr/lib/jvm/java-8-openjdk-amd64/
ENV PATH $PATH:/opt/gradle/bin
ENV EXTRAE_MPI_HEADERS /usr/include/x86_64-linux-gnu/mpi
COPY . /framework
ENV GRADLE_HOME /opt/gradle
ENV JAVA_HOME /usr/lib/jvm/java-8-openjdk-amd64/
ENV PATH $PATH:/opt/COMPSs/Runtime/scripts/user:/opt/COMPSs/Bindings/c/bin:/opt/COMPSs/Runtime/scripts/utils:/opt/gradle/bin
ENV CLASSPATH $CLASSPATH:/opt/COMPSs/Runtime/compss-engine.jar
ENV LD_LIBRARY_PATH /opt/COMPSs/Bindings/bindings-common/lib:$JAVA_HOME/jre/lib/amd64/server
ENV COMPSS_HOME=/opt/COMPSs/
# Install COMPSs
RUN cd /framework && \
./submodules_get.sh && \
export EXTRAE_MPI_HEADERS=/usr/include/x86_64-linux-gnu/mpi && \
/framework/builders/buildlocal /opt/COMPSs && \
mv /root/.m2 /home/jenkins && \
chown -R jenkins: /framework && \
chown -R jenkins: /home/jenkins/
# Expose SSH port and run SSHD
EXPOSE 22
CMD ["/usr/sbin/sshd","-D"]
FROM compss/${BASE}_all as compss
COPY --from=ci /opt/COMPSs /opt/COMPSs
COPY --from=ci /etc/init.d/compss-monitor /etc/init.d/compss-monitor
COPY --from=ci /etc/profile.d/compss.sh /etc/profile.d/compss.sh
ENV JAVA_HOME /usr/lib/jvm/java-8-openjdk-amd64/
ENV PATH $PATH:/opt/COMPSs/Runtime/scripts/user:/opt/COMPSs/Bindings/c/bin:/opt/COMPSs/Runtime/scripts/utils
ENV CLASSPATH $CLASSPATH:/opt/COMPSs/Runtime/compss-engine.jar
ENV LD_LIBRARY_PATH /opt/COMPSs/Bindings/bindings-common/lib:$JAVA_HOME/jre/lib/amd64/server
ENV COMPSS_HOME=/opt/COMPSs/
EXPOSE 22
CMD ["/usr/sbin/sshd","-D"]
FROM compss/${BASE}_tutorial as compss-tutorial
COPY --from=ci /opt/COMPSs /opt/COMPSs
COPY --from=ci /etc/init.d/compss-monitor /etc/init.d/compss-monitor
COPY --from=ci /etc/profile.d/compss.sh /etc/profile.d/compss.sh
ENV JAVA_HOME /usr/lib/jvm/java-8-openjdk-amd64/
ENV PATH $PATH:/opt/COMPSs/Runtime/scripts/user:/opt/COMPSs/Bindings/c/bin:/opt/COMPSs/Runtime/scripts/utils
ENV CLASSPATH $CLASSPATH:/opt/COMPSs/Runtime/compss-engine.jar
ENV LD_LIBRARY_PATH /opt/COMPSs/Bindings/bindings-common/lib:$JAVA_HOME/jre/lib/amd64/server
ENV COMPSS_HOME=/opt/COMPSs/
ENV PYTHONPATH=$COMPSS_HOME/Bindings/python/3:$PYTHONPATH
EXPOSE 22
CMD ["/usr/sbin/sshd","-D"]
FROM compss/${BASE}_rt as minimal
COPY --from=ci /opt/COMPSs /opt/COMPSs
COPY --from=ci /etc/profile.d/compss.sh /etc/profile.d/compss.sh
ENV JAVA_HOME /usr/lib/jvm/java-8-openjdk-amd64/
ENV PATH $PATH:/opt/COMPSs/Runtime/scripts/user:/opt/COMPSs/Bindings/c/bin:/opt/COMPSs/Runtime/scripts/utils
ENV CLASSPATH $CLASSPATH:/opt/COMPSs/Runtime/compss-engine.jar
ENV LD_LIBRARY_PATH /opt/COMPSs/Bindings/bindings-common/lib:$JAVA_HOME/jre/lib/amd64/server
ENV COMPSS_HOME=/opt/COMPSs/
FROM compss/${BASE}_python as pycompss
COPY --from=ci /opt/COMPSs /opt/COMPSs
COPY --from=ci /etc/init.d/compss-monitor /etc/init.d/compss-monitor
COPY --from=ci /etc/profile.d/compss.sh /etc/profile.d/compss.sh
ENV JAVA_HOME /usr/lib/jvm/java-8-openjdk-amd64/
ENV PATH $PATH:/opt/COMPSs/Runtime/scripts/user:/opt/COMPSs/Bindings/c/bin:/opt/COMPSs/Runtime/scripts/utils
ENV CLASSPATH $CLASSPATH:/opt/COMPSs/Runtime/compss-engine.jar
ENV LD_LIBRARY_PATH /opt/COMPSs/Bindings/bindings-common/lib:$JAVA_HOME/jre/lib/amd64/server
ENV COMPSS_HOME=/opt/COMPSs/
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2002-2018 Barcelona Supercomputing Center - Centro Nacional de Supercomputación
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
This product includes software developed by
the Workflows and Distributed Computing Group (WDC)
from Department of Computer Science (CS)
at the Barcelona Supercomputing Center (BSC).
---
name: Pull Request template
about: Describe the changes of a Pull Request you want to merge.
title: ''
labels: ''
assignees: ''
---
# Status
**READY / WORK IN PROGRESS / HOLD**
# Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes #(issue_number)
## Type of change
Please delete options that are not relevant.
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
## Project impact
List the general project components that this PR will affect:
*
## Related PRs
List related PRs against other branches:
branch | PR
------ | ------
other_pr_production | [link]()
other_pr_master | [link]()
# How Has This Been Tested?
Please describe the tests that you ran to verify your changes. If you haven't added any test and it is relevant provide instructions so we can reproduce.
- [ ] I have added a new test with number:
- [ ] I have modified a test to check this. Test number:
- [ ] I have tested it manually in a **local environment**.
- [ ] I have tested it manually in a **supercomputer**.
Reproduce instructions:
```bash
git checkout <feature_branch>
```
# Checklist:
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] New and existing unit tests pass locally with my changes
- [ ] I have run the script to add headers if new files are present (i.e. `utils/scripts/header_setup/replace_all.sh`)
- [ ] I have rebased my branch before trying to merge.
# COMPSs version 3.0
<!-- LOGOS AND HEADER -->
<h1 align="center">
<br>
<a href="https://www.bsc.es/">
<img src="files/logos/bsc_logo.png" alt="Barcelona Supercomputing Center" height="60px">
</a>
<a href="https://www.bsc.es/research-and-development/software-and-apps/software-list/comp-superscalar/">
<img src="files/logos/COMPSs_logo.png" alt="COMP Superscalar" height="60px">
</a>
<br>
<br>
COMPSs Framework
<br>
</h1>
<h3 align="center">Component Superscalar framework and programming model for HPC.</h3>
<p align="center">
<a href='http://bscgrid05.bsc.es/jenkins/job/COMPSs_Framework-Docker_testing'>
<img src='http://bscgrid05.bsc.es/jenkins/job/COMPSs_Framework-Docker_testing/badge/icon'
alt="Build Status">
</a>
</p>
<p align="center"><b>
<a href="https://www.bsc.es/research-and-development/software-and-apps/software-list/comp-superscalar/">Website</a>
<a href="https://www.bsc.es/research-and-development/software-and-apps/software-list/comp-superscalar/documentation">Documentation</a>
<a href="https://github.com/bsc-wdc/compss/releasess">Releases</a>
<a href="https://bit.ly/bsc-wdc-community">Slack</a>
</b></p>
COMP Superscalar (COMPSs) is a programming model which aims to ease the development
of applications for distributed infrastructures, such as Clusters, Grids and Clouds.
COMP Superscalar also features a runtime system that exploits the inherent parallelism
of applications at execution time.
<!-- SECTIONS -->
<!-- DOCUMENTATION -->
# Documentation
COMPSs documentation can be found at the [COMPSs Webpage][1] or at
the `doc/` folder.
* COMPSs_Installation_Manual.pdf
* COMPSs_User_Manual_App_Development.pdf
* COMPSs_User_Manual_App_Execution.pdf
* COMPSs_Supercomputers_Manual.pdf
* Tracing_Manual.pdf
* COMPSs_Developer_Manual.pdf
<!-- PACKAGES -->
# Packages
The COMP Superscalar Framework packages are available at the [COMPSs Webpage][1] or
can be found on the `builders/packages/` directory.
<!-- SOURCES STRUCTURE -->
# Sources Structure
* **builders**: Packages, scripts for local installations, scripts for supercomputers
installation and package building scripts
* **compss** : COMPSs Runtime
* **dependencies** : COMPSs embeded dependencies
* **doc** : COMPSs documentation
* **files** : Dependency files (i.e. paraver configurations)
* **tests** : COMPSs integration tests
* **utils** : Misc utils (i.e. OVA scripts, Docker generation, Storage implementations)
<!-- SAMPLE APPLICATIONS -->
# Sample Applications
You can find extended information about COMPSs Sample applications at the
Sample_Applications manual available at the [COMPSs Webpage][1] or at the
`doc/Sample_applications.pdf`.
<!-- BUILDING COMPSS -->
# Building COMPSs
Follow the next steps to build COMPSs in your current machine.
## 1. Install dependencies
Install the listed dependencies for each component you wish to install. For a complete build please install all the dependencies.
* COMPSs Runtime dependencies
* openjdk-8-jre
* openssh-server
* uuid-runtime
* graphviz
* xdg-utils
* Build dependencies
* wget
* openjdk-8-jdk
* maven
* curl
* jq
* OSX dependencies(use Brew to install it)
* libtool
* coreutils
* boost
* util-linux
* Bindings-common dependencies
* build-essential
* autoconf
* automake
* autotools-dev
* libtool
* C-binding dependencies
* libboost-all-dev
* libxml2-dev
* csh
* Python-binding dependencies
* python-dev | python3-dev
* python-pip | python3-pip
* python-setuptools | python3-setuptools
* libpython3
* wheel
* numpy
* dill
* guppy
* Extrae dependencies
* libxml2
* gfortran
* libpapi-dev
* papi-tools
* AutoParallel dependencies
* libgmp3-dev
* flex
* bison
* libbison-dev
* texinfo
* libffi-dev
* astor
* sympy
* enum34
* islpy
* Streaming dependencies
* Gradle
* Testing dependencies
* openmpi-bin
* openmpi-doc
* libopenmpi-dev
* bc
* decorator
* mpi4py
* redis-py-cluster
* enum34
* tabulate
## 2. Get GIT submodules
Before installing COMPSs you need to download the git submodules that contain its dependencies. To do that execute the following two commands at the root of the repository.
```
./submodules_get.sh
```
## 3. Build COMPSs
**Note**: Remember to install the COMPSs dependencies and to get the GIT submodules before trying to build COMPSs from sources.
* Building COMPSs for all users (not supported in OSX)
```
cd builders/
INSTALL_DIR=/opt/COMPSs/
sudo -E ./buildlocal [options] ${INSTALL_DIR}
```
* Building COMPSs for current user
```
cd builders/
INSTALL_DIR=$HOME/opt/COMPSs/
./buildlocal [options] ${INSTALL_DIR}
```
For OSX: