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

Modernize scripts #97

Merged
merged 1 commit into from
Sep 28, 2018
Merged

Modernize scripts #97

merged 1 commit into from
Sep 28, 2018

Conversation

seisman
Copy link
Member

@seisman seisman commented Sep 26, 2018

Description of proposed changes

  1. Update scripts in doc_modern to modern mode.
  2. Delete some unused scripts
    Fixes Update scripts to modern mode #96

@PaulWessel
Copy link
Member

Hi @seisman. I forgot to say this but given how the entire documentation is built via cmake (and until we make any major changes to how that works), all test, example, and doc scripts must produce just a PS file (not png, etc as these are produced by cmake). For instance, see the test/exmod set of modern mode scripts there.

@seisman
Copy link
Member Author

seisman commented Sep 26, 2018

So, currently all scripts must generate PS only and set paper size to avoid warnings/errors. Looks like this:

gmt begin map ps
gmt set PS_MEDIA letter
...
gmt end

@PaulWessel
Copy link
Member

Yes, except we don't need to set the PS_MEDIA letter since that is set globally by cmake when these scripts are run.

@PaulWessel
Copy link
Member

Thanks for all your work @seisman. However, unless I am missing something it looks like many of the scripts do not start with gmt begin and therefore will run in classic mode. Was this intentional?

@seisman
Copy link
Member Author

seisman commented Sep 27, 2018

@PaulWessel I'm still working on it. Currently, I only finished scripts related to common options, e.g. GMT_-B_*.sh, GMT_-J.sh, GMT_-R.sh ...

For other scripts, I only did the renaming of some modules, e.g. psbasemap to basemap. That's why all scripts are changed but some don't run in modern mode.

@seisman
Copy link
Member Author

seisman commented Sep 28, 2018

@PaulWessel I have done following changes in this PR:

  1. update most scripts to modern mode
  2. delete unused scripts GMT_-OK.sh and GMT_-P.sh

Following scripts are not changed, since I'm not sure what to do with these scripts:

  • func_F_iso+.sh (why write to stdout)

  • func_F_stand+.sh (why write to stdout)

  • GMT_App_F_iso+.sh (seems never used)

  • GMT_App_F_stand+.sh (seems never used)

  • GMT_App_F_stand+_iso+.sh

  • GMT_App_F_symbol.sh (seems never used)

  • GMT_App_F_dingbats.sh (seems never used)

  • GMT_App_F_symbol_dingbats.sh

  • GMT_App_P_1.sh (Shall we remove isolation mode? Because it's similar to modern mode)

  • GMT_App_P_2.sh (Shall we remove isolation mode? Because it's similar to modern mode)

  • GMT_RGBchart.sh (The script runs in isolation mode)

You can review the changes now and also update these PS files.

@seisman seisman changed the title WIP: Modernize scripts Modernize scripts Sep 28, 2018
@PaulWessel
Copy link
Member

Some of these scripts (func_F_iso+.sh etc) are called by other scripts. THey are not exposed to any users via documentation - they are jus there to make certain figures in the appendix. We can leave them as is for now.

Copy link
Member

@PaulWessel PaulWessel left a comment

Choose a reason for hiding this comment

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

Thanks, we will add these in and see if there are any side-effects.

@PaulWessel PaulWessel merged commit 3905642 into master Sep 28, 2018
@seisman seisman deleted the modernize-scripts branch September 29, 2018 01:57
obaney pushed a commit to obaney/gmt that referenced this pull request Aug 18, 2021
…ls#97)

Instead of having the API for gmt, gmt.clib etc in separate pages, put
them all in the same one.
sphinx autosummary doesn't support this directly so I'm generating the
module references in a dummy page and then including them in api/index.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants