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

Manual: Updates for 0.4.0 #2685

Merged

Conversation

ax3l
Copy link
Member

@ax3l ax3l commented Aug 11, 2018

  • add tbg section
  • update "basic usage" section:
    • fix outdated .cfg file names
    • improve clarity and structure
  • update install instructions:
    • refresh version ranges
    • update min. alpaka
    • add notes, e.g. to spack and use nvidia docker 2+
    • replace wget with more widespread curl command (linux/osx)
    • remove untar verbosity

Greetings from Toronto Airport!

@ax3l ax3l added the documentation regarding documentation or wiki discussions label Aug 11, 2018
INSTALL.rst Outdated
@@ -89,13 +89,16 @@ zlib

boost
"""""
- 1.62.0-1.64.0 (``program_options``, ``regex`` , ``filesystem``, ``system``, ``math``, ``serialization`` and header-only libs, optional: ``fiber`` with ``context``, ``thread``, ``chrono``, ``atomic``, ``date_time``)
- download from `http://www.boost.org <http://sourceforge.net/projects/boost/files/boost/1.62.0/boost_1_62_0.tar.gz/download>`_
- 1.62.0 - 1.68.0 (``program_options``, ``regex`` , ``filesystem``, ``system``, ``math``, ``serialization`` and header-only libs, optional: ``fiber`` with ``context``, ``thread``, ``chrono``, ``atomic``, ``date_time``)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Help wanted: we should verify that boost 1.67.0 and 1.68.0 work for us, especially with nvcc

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1.67.0 seems to be working, 1.68.0 is problematic (see alpaka link below)

@ax3l ax3l force-pushed the doc-usageUpdates040 branch from 618a914 to a53810b Compare August 11, 2018 19:50
@ax3l ax3l mentioned this pull request Aug 11, 2018
4 tasks
@@ -3,15 +3,29 @@
TBG
===

.. sectionauthor:: Axel Huebl, Richard Pausch
Copy link
Member Author

@ax3l ax3l Aug 11, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved below to shared section.
Will potential move to new page in the future.

@ax3l ax3l force-pushed the doc-usageUpdates040 branch from a53810b to 6c1892f Compare August 11, 2018 20:02
Copy link
Member

@PrometheusPi PrometheusPi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a typo
will check boost on Monday

USAGE.rst Outdated

pic-create
""""""""""

This tool is just a short-hand to create a new set of input files.
It does a copy from an already existing set of input files (e.g. our examples or a previous simulation) and adds additional default files.
It does a copy from an already existing set of input files (e.g. our examples or a previous simulation) and adds additional helper files.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

optional:
better wording:
It copies from an already ...


We abstract the description of queues, resource acquisition and job submission away from PIConGPU user input via *template files* (``.tpl``).
For example, the ``.cfg`` file defines how many *devices* shall be used for computation, but the ``.tpl`` file calculates how many *physical nodes* will be requested.
Also, the ``.tpl`` file takes care off how to spawn a process when scheduled, e.g. with ``mpiexec`` and which flags for networking details need to be passed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo
off -> of

Copy link
Member

@PrometheusPi PrometheusPi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry I selected the wrong field - typo requires changes

@ax3l
Copy link
Member Author

ax3l commented Aug 12, 2018

Cross-link: Alpaka Boost 1.68.0 support status https://github.com/ComputationalRadiationPhysics/alpaka/pull/606

An unfortunate aspect about batch systems from a user's perspective is, that their usage varies a lot.
And naturally, different systems have different resources in queues that need to be described.

We abstract the description of queues, resource acquisition and job submission away from PIConGPU user input via *template files* (``.tpl``).
Copy link
Member

@sbastrakov sbastrakov Aug 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel it's a little imprecise: queues, resource acquisition and job submission are not part of PIConGPU user input per se (at least queues are not), but part of a launch command line. Maybe just remove words from PIConGPU user input ?

And naturally, different systems have different resources in queues that need to be described.

We abstract the description of queues, resource acquisition and job submission away from PIConGPU user input via *template files* (``.tpl``).
For example, the ``.cfg`` file defines how many *devices* shall be used for computation, but the ``.tpl`` file calculates how many *physical nodes* will be requested.
Copy link
Member

@sbastrakov sbastrakov Aug 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think here the .cfg file is rather unnatural, we are talking in general about a configuration file, right? There are also other cases I'm not sure about, but this one jars on my ears.

For example, the ``.cfg`` file defines how many *devices* shall be used for computation, but the ``.tpl`` file calculates how many *physical nodes* will be requested.
PIConGPU runtime options are described in *configuration files* (``.cfg``).
We abstract the description of queues, resource acquisition and job submission via *template files* (``.tpl``).
For example, a ``.cfg`` file defines how many *devices* shall be used for computation, but a ``.tpl`` file calculates how many *physical nodes* will be requested.
Also, the ``.tpl`` file takes care of how to spawn a process when scheduled, e.g. with ``mpiexec`` and which flags for networking details need to be passed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, did not mark it last time. Here it also has to be a tpl file.

ax3l added 6 commits August 13, 2018 08:50
Fix outdated .cfg file names.
Improve clarity and structure.
Refresh version ranges, update min. alpaka, add notes,
replace wget with more widespread curl command, remove
untar verbosity.
We can probably add work-arounds later to PMacc and Alpaka.
But right now, it's not usable with NVCC.
@ax3l ax3l force-pushed the doc-usageUpdates040 branch from 3df463a to 5288bc2 Compare August 13, 2018 14:50
@PrometheusPi PrometheusPi self-assigned this Aug 13, 2018
@ax3l
Copy link
Member Author

ax3l commented Aug 16, 2018

@PrometheusPi ping :)

@PrometheusPi PrometheusPi merged commit 8b57a3c into ComputationalRadiationPhysics:dev Aug 16, 2018
@ax3l ax3l deleted the doc-usageUpdates040 branch August 16, 2018 14:27
psychocoderHPC added a commit to psychocoderHPC/picongpu that referenced this pull request Oct 4, 2018
Boost 1.68.0 is not allowed since ComputationalRadiationPhysics#2685 but after we will integrate the next alapak release we will end in compile issues.
The reason is ComputationalRadiationPhysics#2707. The definition of `boost::math::gcd` is not available if `boost/integer/common_factor_rt.hpp` is included.

This PR fixes the behaviour be using always `boost/integer/common_factor_rt.hpp` and use `boost::integer::gcd` within PMacc.
@psychocoderHPC psychocoderHPC mentioned this pull request Oct 4, 2018
2 tasks
ax3l pushed a commit to ax3l/picongpu that referenced this pull request Oct 5, 2018
Boost 1.68.0 is not allowed since ComputationalRadiationPhysics#2685 but after we will integrate the next alapak release we will end in compile issues.
The reason is ComputationalRadiationPhysics#2707. The definition of `boost::math::gcd` is not available if `boost/integer/common_factor_rt.hpp` is included.

This PR fixes the behaviour be using always `boost/integer/common_factor_rt.hpp` and use `boost::integer::gcd` within PMacc.
steindev pushed a commit to steindev/picongpu that referenced this pull request Oct 16, 2018
Boost 1.68.0 is not allowed since ComputationalRadiationPhysics#2685 but after we will integrate the next alapak release we will end in compile issues.
The reason is ComputationalRadiationPhysics#2707. The definition of `boost::math::gcd` is not available if `boost/integer/common_factor_rt.hpp` is included.

This PR fixes the behaviour be using always `boost/integer/common_factor_rt.hpp` and use `boost::integer::gcd` within PMacc.
steindev pushed a commit to steindev/picongpu that referenced this pull request Oct 16, 2018
Boost 1.68.0 is not allowed since ComputationalRadiationPhysics#2685 but after we will integrate the next alapak release we will end in compile issues.
The reason is ComputationalRadiationPhysics#2707. The definition of `boost::math::gcd` is not available if `boost/integer/common_factor_rt.hpp` is included.

This PR fixes the behaviour be using always `boost/integer/common_factor_rt.hpp` and use `boost::integer::gcd` within PMacc.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation regarding documentation or wiki discussions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants